This patch proposes some changes to the doxygen configuration. The first two changes add directories to the file lists, which is a good idea, as gnucash uses quite a detailed set of directories to organize things, and it was a hassle to switch between the doxygen documentation and the actual source code without the directory names.
The next adds a Directory view, which seems useful, for the reasons mentioned above. Next, I turned on the progress messages, so I could be sure something was happening as I repeatedly regenerated the docs to test these configuration changes. I think it's mostly a matter of personal preference whether we want them on or not... The INPUT tag had a redundant entry, left over from when libqof wasn't under src, so I removed it. Adding lists of what functions call a given function doesn't seem to increase generation time appreciably, and it's nice to have, so I turned it on. Since the source code for functions are listed inline, the source code view is secondary, so it felt better to have the references links go to the documentation, rather than the source view, so I made that so. I didn't turn on VERBATIM_HEADERS, but I wondered why we turned it off? Hopefully this patch won't have any tag vs. spaces issues, like the last one... Thanks for the encouragement and friendly reception, Jesse Weinstein
=== modified file 'src/doc/doxygen.cfg.in' --- src/doc/doxygen.cfg.in 2010-02-25 10:07:22 +0000 +++ src/doc/doxygen.cfg.in 2010-03-03 08:31:24 +0000 @@ -105,7 +105,7 @@ # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. -FULL_PATH_NAMES = NO +FULL_PATH_NAMES = YES # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is @@ -114,7 +114,7 @@ # If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = @-top_srcdir-@/src # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells @@ -459,7 +459,7 @@ # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. -SHOW_DIRECTORIES = NO +SHOW_DIRECTORIES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the @@ -499,7 +499,7 @@ # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. -QUIET = YES +QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank @@ -552,8 +552,7 @@ # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @-top_srcdir-@/src \ - @-top_srcdir-@/src/libqof/ +INPUT = @-top_srcdir-@/src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -685,7 +684,7 @@ # then for each documented function all documented # functions referencing it will be listed. -REFERENCED_BY_RELATION = NO +REFERENCED_BY_RELATION = YES # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities @@ -698,7 +697,7 @@ # 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 +REFERENCES_LINK_SOURCE = NO # 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
_______________________________________________ gnucash-devel mailing list gnucash-devel@gnucash.org https://lists.gnucash.org/mailman/listinfo/gnucash-devel
