about doxygen and doxymacs

To make doxymacs searching code documents (C-c d ?), we need the tag file from doxygen, so need a setting

 

And for using in a developing code, which is not well documented, we need

EXTRACT_ALL            = YES

And for deleper to see all the contents, we need

EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES

The tag file only lists where the tag is in the HTML document. However, the XML output, especially the one-file format which can get by

xsltproc combine.xslt index.xml >all.xml

holds everything doxygen knows. So parsing this file may make a source code browser like (x)cscope. If this can works in Emacs, we can beat xref :)

There is an XML parser library for this doxygen output in the addon/doxmlparser directory of the release, and an example called metrics. However I can’t get them compiled on my FreeBSD, both version 1.3.6 and 1.4.1.

Note for the code browsing purpose, we might want to set

XML_PROGRAMLISTING     = NO

to reduce the size of the XML file and speed up. Also we need

GENERATE_XML           = YES

to get the XML output.

The interface (both the user interface and the c-lisp interface) can model the (x)cscope package. The license of C source file will depend on the doxygen parser lib. Also we might borrow some interface from the xref package.

Tags: , , ,

Post a Comment

You could use <code type="name"> to get your code colorized

Your email is never published nor shared. Required fields are marked *

Close
E-mail It