Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen doesn't appear to recognise comments (Doxywizard)

I am sure this is something silly I've done but I can't see what it is:

So I have c++ project which has a main.cpp file and some classes. It was not written with doxygen in mind (error #1) but I'm looking to correct my mistake and generate some documentation. So I installed doxygen and ran the doxygen GUI, entered the project name/synopsis and specified the source and destination locations.

Also to get some output above a function I added a comment in the style the doxygen spec requires:

//! My actual function doesn't really look like this
/*! 
 *  Some sample detail which isn't exactly the same as the main
 *  function but the structure is the same
 */
void sampleFunction()
{
    doSomethingUninteresting();
}

However when I hit run in doxywizard no extra comments are made.

If I set the extraction mode to documented entities only main.cpp doesn't even show up. If I set it to all entities main.cpp appears under files and the function is in there however there is no detail whatsoever in the file.

As a complete novice trying to retrofit my project no doubt I've omitted to do something important but all the documentation/tutorials I've read don't suggest anything other than what I've stated needs to be done so I turn to the knowledgeable SO community for assistance

UPDATE:

In response to the comment by Arne Mertz here are a few more details:

  • Doxywizard is in Program Files/doxygen/bin and the config file is wherever doxywizard creates it by default

  • My source code is in User/Desktop/

  • The output folder is in User/Desktop/Documentation

like image 896
DomAyre Avatar asked Nov 21 '25 22:11

DomAyre


1 Answers

To document a global functions you have also to include a file name. E.g.

/*!
 * \file MyFileName.cpp
 * \brief a brief description of a file
 */

//! My actual function doesn't really look like this
/*! 
 *  Some sample detail which isn't exactly the same as the main
 *  function but the structure is the same
 */
void sampleFunction()
{
    doSomethingUninteresting();
}

Note, that the name after \file keyword should be exactly as the name of the file.

like image 144
Hi-Angel Avatar answered Nov 23 '25 11:11

Hi-Angel



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!