ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Private functions in a class #55

Closed Shubhamtakbhate1998 closed 1 year ago

Shubhamtakbhate1998 commented 1 year ago

Private functions in the cpp class don't show up.

Yadunund commented 1 year ago

You should be able to write a custom doxyfile in the root of your package that has instructions to look for header files from include and src if you choose. Then rosdoc2 will invoke doxygen while passing this doxyfile as config. By default only files in include are considered

I'll close this ticket as it's an issue with configuring doxygen as opposed to this tool itself. But feel free to reopen if you feel otherwise.

Shubhamtakbhate1998 commented 1 year ago

class MyClass { private: void privateFunction() { // Code for the private function } public: void publicFunction() { // Code that uses the private function privateFunction(); } };

Here the Public function will appear in the documentation but private function will not appear.