GNOME Bugzilla – Bug 793084
Freestanding functions do not have a top level tab
Last modified: 2018-07-30 11:00:02 UTC
I work with the Crypto++ project, https://www.cryptopp.com/. We use Doxygen for our online documentation. The documentation is at https://www.cryptopp.com/docs/ref/. The landing page has top level tabs for Mainpage, Namespaces, Classes, and Files. There is no top level tab for functions. For users to find functions, they must know either (1) the function name, or (2) the function's source file. For example, here are the freestanding functions in our file misc.h: https://www.cryptopp.com/docs/ref/misc_8h.html . If users do not know (1) or (2) then they have no way to browse or find the function they need. Please add a top level tab for freestanding functions, and add documented functions to the tab so users can find them.
Bump... More problems finding free-standing functions. On Fri, May 18, 2018 at 8:11 PM, Jeffrey Walton <...> wrote: > On Fri, May 18, 2018 at 12:01 PM, ... >> >> Somehow the added NaCl API is not shown in the Doxygen output. >> >> I'm trying to use that API now, so getting the docs to work would be nice. Any suggestion? > > Yeah, Doxygen does not have a tab for free-standing functions. To see > the docs you have to navigate to the header file at > https://www.cryptopp.com/docs/ref/naclite_8h.html. > > The interface is not that easy to use. Checkout > https://github.com/weidai11/cryptopp/blob/master/validat4.cpp . > > I filed a Doxygen bug asking for a tab for free-standing functions at > "Freestanding functions do not have a top level tab", > https://bugzilla.gnome.org/show_bug.cgi?id=793084.
Looks like that the description is reasonable clear, but please attach a, small, self contained example (source+config file in a tar or zip) that allows us to reproduce the problem(s)? It is better not to have references to places outside the bug report as the are not / might not be persistent.
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!