MOE icon indicating copy to clipboard operation
MOE copied to clipboard

[C++] C++ autodoc pipeline joins header and source comments

Open suntzu86 opened this issue 10 years ago • 0 comments

Right now, if we have:

in .hpp:
/*!\rst
  blah blah

  \param
    :blah: blah
  \return
    stuff
\endrst*/
void foo();

in .cpp:
/*!\rst
  implementation details
\endrst*/
void foo() {}

the autodoc system will lump both comment blocks together into one big blob. This looks kind of ugly and a bit confusing b/c usually the comments in the cpp are implementation-specific and aren't needed by general users. We should consider:

  1. figure out how to keep hpp and cpp comments separate. hpp and cpp files are already identified separately so we just need to make the system willing to print things separately.
  2. remove the rst from implementation comments so that they stop showing up in the web-docs.
  3. something else...?

suntzu86 avatar Aug 06 '14 23:08 suntzu86