#Doxygen special commands install
#Doxygen special commands code

This could be handy for archiving the generated documentation or if some version control system is used.Ħ. PROJECT_NUMBER The PROJECT_NUMBER tag can be used to enter a project or revision number. PROJECT_NAME The PROJECT_NAME tag is a single word (or a sequence of words surrounded by double-quotes) that should identify the project for which the documentation is generated.ĥ.

_EXCLUDE_ & _EXCLUDE PATTERN_ The EXCLUDE tag can be used to specify files and/or directories that should excluded from the INPUT source files. _FILE PATTERNS_ If the value of the INPUT tag contains directories, you can use the FILE_PATTERNS tag to specify one or more patterns (like *.c and *.h).ģ. _INPUT_ To give the path of the directory in other terms - source directory.Ģ. Some major parameters available in Doxygen configuration file is listed below so that you can start playing around with these,ġ. * Project related options * Build related options * Input related options * Source browsing related options * HTML related options * LaTeX related options In this config file, we can modify/customize the doxygen behavior.įor simpler understanding, we can change the output directory, input source location, format of output generated, files to be excluded etc with this configuration file.īelow are the categorizations that can be modified with configuration file. First step would be generating the configuration file. Normal multiline command syntax /// /// - Content Here - /// Considering C/C++, we can modify the default commenting as below mentioned formats, so that doxygen can understand the information provided.Ĭ style comments: /** * - Content Here - */ There are various formats to define a doxygen comments. Hence in case you are a PYTHONISTA, you can(effectively) do the documentation with inbuilt `docstrings` or with tools like `sphinx`. Doxygen can do recognize the python commands, but couldn’t understand most of the pythonic syntax.

#Doxygen special commands install

You can install doxygen in linux with command sudo apt-get install doxygenįor Windows, installing the GUI version of software provides command line support too.ĭoxygen supports languages such as C, C++, Java, C# etc. You can either opt with a GUI way of usage or a terminal(or command prompt) way of usage.

Doxygen:ĭoxygen is available for all platforms like Windows, Linux and Mac. This post would assist you as a bridge to know the tool from basics and also elevating to advanced level. And one such widely used tool is Doxygen. Besides, the project will have a separate document(word/Pdf) explaining about the project.īut, there is more effective ways of documenting your code. In my projects, I have been adding multiple lines of comments, to explain about the module or to add some important info needed for that block of code.

#Doxygen special commands code

Even if a new member starts going through an already available code or the author(him/her/they) is in need to understand a complex module written in the past, documentation could save the day. Documenting your code is a form of art! A well documented code could save you in various scenarios.