When attempting to create a markdown link to the documentation of a template class specialization, Doxygen creates broken html output. The following link will not appear correctly, for example:. Links to members of the specialization work correctly. Non-markdown links also work correctly. To Reproduce This is the project that created the above screenshot:. The text was updated successfully, but these errors were encountered:.
Sorry, something went wrong. This issue was previously marked 'fixed but not released', which means it should be fixed in doxygen version 1. Please verify if this is indeed the case. Then install as you would install any other normal application! The GUI interface on windows looks something like this. This tab is made for the beginners of this tool and it has all the basic necessary options to create documentation using Doxygen. In the above picture, the Project sub-tab is already selected and you get the following 3 options in it.
Be sure to check the Scan recursively button to make Doxygen search all the subfolders too. If you run Doxygen with the settings above, giving it an empty folder as a source directory, you would get something like this. As you can see in the above picture, The logo which I created for this tutorial , the project name, version, and synopsis are shown at the top of the generated HTML.
Keep the Height of the Logo to px, to ensure a good fit as Doxygen is not smart enough to resize it for us. But some people prefer to document all entities, as this would point out the functions which are not documented, as an indicator that it needs documentation. I leave it up to you to experiment with both options and decide on one. This tab lets you select the type of output you need.
I personally never use Latex so I unchecked that and other than that I have kept the default settings here as shown in the picture below. I have not experimented much with the diagram generation options of Doxygen as most of these are geared towards the object-oriented languages. I personally prefer just the architecture diagrams, which I make myself for my projects so hence I keep the diagrams option to No diagrams as shown below.
Instead, we can get the output to start from the root directory of the project itself. As we saw above, there are 2 levels of description for any given entity, a brief description, and detailed description. The first 4 options mentioned above are pretty self-explanatory.
It basically prints a line at the end of pages showing structs the list of files used to generate the documentation. For example, consider the following header file. Basically we are trying to eliminate this portion of the documentation by unchecking that option.
For a simple sample code, it might look okay to have this part, but for a real-word project, the clutter can add up and intrude and actual useful documentation. I suggest you experiment for yourself and find out if you need this portion or not.
This basically controls the log printed as you run the Doxygen and has nothing to do with the content of the generated HTML. This one contains the options to control the files which are being used to generate the documentation. While writing C code, we often find ourselves using libraries from 3rd parties.
These libraries usually contain a large number of files and it might add unnecessary clutter to the documentation. If you have folders that you need to exclude from the documentation, then you can add them to the exclude tab as shown below.
I normally remember the modules a particular struct is placed in and not its actual name so I uncheck this option to eliminate documentation like this. You can experiment and figure out for yourself if you need it. Skip to content. Star 3. New issue. Jump to bottom. Copy link. Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment.
0コメント