[Doxygen] Hoe "references" en "referenced by" toevoegen?

[Verwijderd]

Omdat je nooit te oud bent om te leren, ben ik mijn code aan het documenteren. Ik gebruik javadoc-style en Doxygen als generator. Ik heb de howto van dat programma doorgenomen, en deel mijn code nu in in groepen. "Zo ver, zo goed".

Maar nu wil ik graag, net als bijvoorbeeld hier een opsomming in de documentatie krijgen over welke functies naar een bepaalde functie refereren en naar welke functies een functie refereert. Ik kan nergens in de documentatie vinden met welke instellingen dit kan. Het moet kunnen, want de pagina waarnaar ik verwijs is ook mbv. Doxygen gegenereerd.

Ik heb de ontwikkelaar van Doxygen, Dimitri van Heesch, gemaild maar heb nog geen antwoord terug. Waarschijnlijk is hij druk of op vakantie Weet iemand hier hoe ik dit kan bereiken?

[winkelwagen]

Heb je niet zulke opties staan in je .doxyfile?

code:

# If the REFERENCED_BY_RELATION tag is set to YES
# then for each documented function all documented
# functions referencing it will be listed.

REFERENCED_BY_RELATION = YES

# If the REFERENCES_RELATION tag is set to YES
# then for each documented function all documented entities
# called/used by that function will be listed.

REFERENCES_RELATION = YES

# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
# link to the source code.  Otherwise they will link to the documentstion.

REFERENCES_LINK_SOURCE = YES

# If the USE_HTAGS tag is set to YES then the references to source code
# will point to the HTML generated by the htags(1) tool instead of doxygen
# built-in source browser. The htags tool is part of GNU's global source
# tagging system (see http://www.gnu.org/software/global/global.html). You
# will need version 4.8.6 or higher.

USE_HTAGS = NO

[Verwijderd]

Yes, perfect! Ik heb de GUI-versie gedownload en was me niet bewust dat ik ook handmatig de doxyfile kon aanpassen. Ik heb de GUI wel tien keer doorgelopen, maar kwam deze optie niet tegen. Dit werkt trouwens veel makkelijker dan via GUI, anyways...bedankt

[Verwijderd]

Nog een Doxygen vraag voor de cracks onder ons:

code:

The FILE_VERSION_FILTER tag can be used to specify a program or script that doxygen 
should invoke to get the current version for each file (typically from the version 
control system). Doxygen will invoke the program by executing (via popen()) the 
command command input-file, where command is the value of the FILE_VERSION_FILTER tag, 
and input-file is the name of an input file provided by doxygen. Whatever the program 
writes to standard output is used as the file version.

Example of using a shell script as a filter for Unix:
FILE_VERSION_FILTER = "/bin/sh versionfilter.sh"

Example shell script for CVS:
#!/bin/sh
cvs status $1 | sed -n 's/^[ \]*Working revision:[ \t]*\([0-9][0-9\.]*\).*/\1/p'

Example shell script for Subversion:
#!/bin/sh
svn stat -v $1 | sed -n 's/^[ A-Z?\*|!]\{1,15\}/r/;s/ \{1,15\}/\/r/;s/ .*//p'

Example filter for ClearCase:
FILE_VERSION_INFO = "cleartool desc -fmt \%Vn"

Ik heb geen SVN of ander versie controle systeem draaien. Met welk Windows XP commando kan ik hier de "last modified" tijd van elk bestand retourneren? Als ik hier niets invul, geeft Doxygen telkens bij elk bestand een foutmelding. Als je de variabele leeg laat, gebruik hij standaard de optie shell script voor Subversion, en dan krijg ik 10.000x "sed is not a recognized internal or external command ..." error

[Nick_S]

Je kan met Unixtools sed installeren en dan met ls en sed gaan rommelen of gewoon lokaal Subversion gaan draaien (Wat natuurlijk nog veel meer mogelijkheden biedt, voor al m'n hobbyprojecten draai ik een versie beheer, gewoon om history terug te kunnen draaien)

[ingdas]

Wow, wij hebben op de universiteit een vak dat zich voor een groot stuk concentreert op het documenteren van code maar van Doxygen hadden wij nog nooit gehoord. Super programma gewoon. Bedankt om deze vraag te stellen, anders had ik dit nooit ontdekt.