The notation is not common in doxygen documentation, I'm not sure how the program will treat these so it is probably best to not use this style. see Describes a cross-reference to classes, functions, methods, variables, files or. By dividing the sources into several 'packages', the sources of one package can be parsed by doxygen, while all other packages that this package depends on, are linked in externally. If these are not working as expected the OP should include some example documentation you we can try and work out which this is not working as expected. For very large source trees, letting doxygen parse all sources may simply take too much of your systems memory. In this class we will use it extensively for the C++ projects.
#DOXYGEN LINK TO CLASS CODE#
Doxygen can be used to generate code for a variety of languages, including Java and C++.
Just head over to this link and scroll down to the section Sources and Binaries and download the version that has support for your particular operating system, be it Linux or Mac or Windows. Doxygen is a popular tool to document your code, i.e. To link to an all lower case symbol, use \ref.ĭoxygen does accept the \see (which is synonymous to \sa) and \link commands. The installation of Doxygen is as simple as it can get. If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a % in front of the word. No internal links to classes in java.
The same issue occurs without external linking if one processes the source of the java.base module with Doxygen. This is because Doxygen does not consider that the package java.lang is always implicitly imported.
#DOXYGEN LINK TO CLASS MANUAL#
You can use the \link command, but you must end your link text with the \endlink command, which I suspect is your problem (although without example documentation I can't be sure).įrom the doxygen manual section on automatic linking, which I suggest you read, there is a paragraph on links to classes:Īll words in the documentation that correspond to a documented class and contain at least one non-lower case character will automatically be replaced by a link to the page containing the documentation of the class. Notice how Vector is properly linked to its external resource while String is not.
If a relative path is entered, it will be relative to the location where doxygen was started. Doxygen will automatically replace any URLs and mail addresses found in the documentation by links (in HTML).
#DOXYGEN LINK TO CLASS SOFTWARE#
PROJECTLOGO The OUTPUTDIRECTORY tag is used to specify the (relative or absolute) path into which the generated documentation will be written. The Free Software Foundation gives permission to use and distribute the program source documentation strings, after processing them through Doxygen or some. To link to other classes you should use the ref command. Doxygen will copy the logo to the output directory.
0 kommentar(er)
