Best Tips for documenting code using doxygen? [closed]

by

You don’t need and should not write the name of the file in the @file directive, doxygen reads the name of the file automatically. The problem with writing the name of the file is that when you rename the file you will have to change the @file directive as well.

Providing @author and @date information is also useless most of the time since the source control system does it a lot better than someone editing the files manually.

You also don’t have to write @brief if you use the following Doxygen syntax and enable JAVADOC_AUTOBRIEF in doxygen’s configuration:

/*! Short Description on the first line

    Detailed description...
    ...
*/
void foo(void) {}

The @name directive for functions is also 100% redundant most of the time and completely useless. It only brings errors when someone modifies the name of the function and not the doxygen @name.

More Related Contents:

  1. How to use doxygen to create UML class diagrams from C++ source
  2. Where are the man pages for C++? [closed]
  3. Return array in a function
  4. Printing the correct number of decimal points with cout
  5. Programmatically find the number of cores on a machine
  6. Why must the copy assignment operator return a reference/const reference?
  7. Does const mean thread-safe in C++11?
  8. Lock-free Progress Guarantees in a circular buffer queue
  9. What is the ‘this’ pointer?
  10. How to implement make_unique function in C++11? [duplicate]
  11. generate random double numbers in c++
  12. How do you find what version of libstdc++ library is installed on your linux machine?
  13. What is the use of having destructor as private?
  14. How to write C++ getters and setters
  15. Casting pointer to Array (int* to int[2])
  16. Why does a%b produce SIGFPE when b is zero?
  17. Calling a virtual function from the constructor
  18. C++ Thread-Safe Map
  19. Understanding stack frame of function call in C/C++? [closed]
  20. Is the backslash acceptable in C and C++ #include directives?
  21. How is C++ std::vector implemented?
  22. How to output fraction instead of decimal number?
  23. How do YOU reduce compile time, and linking time for Visual C++ projects (native C++)?
  24. Correct usage of the Eigen::Ref class
  25. Possible causes for Boost not being found by CMake in certain situations?
  26. Making a vector of instances of different subclasses
  27. C++ : handle resources if constructors may throw exceptions (Reference to FAQ 17.4]
  28. Memory alignment : how to use alignof / alignas?
  29. Portable Compare And Swap (atomic operations) C/C++ library?
  30. Why is a c++ reference considered safer than a pointer?

Leave a Comment