Databases
StackOverflow2013
Postsdbo
POMaking Doxygen read double-slash C++ comments as markup
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POMaking Doxygen read double-slash C++ comments as markup
    primarykey
    data
    text
    <p>I'm trying to set up automated <a href="http://www.doxygen.org/">Doxygen</a> runs on our massive 78,000 file C++ codebase. It's doing okay with extracting basic type and hierarchy information, but I'd like to make it smarter about picking up the documentation comments that are already in place.</p> <p>Most of the comments that have accumulated over the years do follow a general pattern, though not the pattern that Doxygen expected. Mostly they look like </p> <pre><code>// class description class foo { // returns ascii art of a fruit const char* apples( void ); // does something to some other thing customtype_t baz( foo &amp;other ); enum { kBADGER, // an omnivorous mustelid kMUSHROOM, // tasty on pizza kSNAKE, // oh no! }; } </code></pre> <p>Which are double-slashed, rather than the <code>///</code> or <code>//!</code> style comments that Doxygen expects.</p> <p>There are far too many files to go through searching and replacing all such comments, and many of my programmers are violently allergic to seeing triple-slashes in their code, so I'd like to find some way to make Doxygen read ordinary comments as JavaDoc comments, when they're in the right place. <strong>Is there a way to make Doxygen read <code>//</code> as <code>///</code>?</strong> </p> <p>I couldn't find any such configuration parameter, so I figure I'll need to transform the input somehow. In general the rule I'd use is:</p> <ul> <li>if there is a line containing just a comment, immediately preceding a function/class/type/variable declaration, assume it is a <code>///</code> comment. </li> <li>if there is a declaration followed on the same line by a <code>//</code> comment, treat it as a <code>///&lt;</code></li> </ul> <p>But I don't know how to go about teaching Doxygen this rule. The two ways I can think of are:</p> <ol> <li>Write a program as an <a href="http://www.stack.nl/~dimitri/doxygen/config.html#cfg_input_filter">INPUT_FILTER</a>, which parses the input C++ and transforms <code>//</code>s into <code>///</code>s as above. But this kind of transform is too complicated to do as a regular expression, and I really don't want to have to write a full blown C++ parser just to feed input to another C++ parser! Also, spinning up an INPUT_FILTER program for each file slows down Doxygen unacceptably: it already takes over 30 minutes to run across our source, and adding an <a href="http://www.stack.nl/~dimitri/doxygen/config.html#cfg_input_filter">INPUT_FILTER</a> makes it take over six hours.</li> <li>Modify the Doxygen source code to include the above comment rules. That seems like a scary amount of work in unfamiliar code.</li> </ol> <p>Any other ideas?</p>
    singulars
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PTQuestion
    1. USCrashworks
    1. USCrashworks
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POMaking Doxygen read double-slash C++ comments as markup
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POMaking Doxygen read double-slash C++ comments as markup
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POMaking Doxygen read double-slash C++ comments as markup
      1. This table or related slice is empty.
      1. VTUpMod
    1. COWhat about a little script that runs through the directories once, looks for `// ` (with space) in the code and turns it into `/// `? Also, if your coder are allergic against `///`, tell them to get something from the pharmacy.
      singulars
      1. POMaking Doxygen read double-slash C++ comments as markup
      1. USXeo
    2. COYou can modify the parser of doxygen so it uses `//` instead of `///` in certain places. Doxygen is opensource after all. From the FAQ: `it is probably not too hard to tweak src/scanner.l`
      singulars
      1. POMaking Doxygen read double-slash C++ comments as markup
      1. USrve
    3. CO@Xeo If I actually checked out, modified, and checked in 78000 files just to modify the comments to a format no one likes, I'd be fired before lunchtime.
      singulars
      1. POMaking Doxygen read double-slash C++ comments as markup
      1. USCrashworks
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload