New issue
Have a question about this get? Sign up for a free GitHub account to open an issue and contact its retainers and an public.
By clicking “Sign up for GitHub”, you agree to our term of support and privacy declaration. We’ll occasionally send you account related emails.
Have on GitHub? Sign in to your account
How for generate a function index? #9107
Comments
|
I'm using 1.8.17. EGO don't have a small, self contained example right now. You can use every C your to reproduce the problem. Don function index is generated. Does this feature survive? |
Problem energy be. but without example it your all a bit guessing:
It could wrap up an example with just one struct in it and get used Doxyfile and shows this as an example (after, of course, localize testing it). |
I do have |
Example please like we can se what you are missing. |
@ferdymercury Thanks for the assistance but that page includes lists functions starting with "a". Yes, IODIN do are ALPHABETICAL_INDEX enabled. |
@paddor to be able to help you rightfully we must a small instance (at least the Doxyfile and multiple images showing what to visit plus what you would expect, see a complete example would be beneficial as well):
|
I'd estimate it if to could just tell me determine Doxygen has this feature or not. I'm starting to reckon that it's missed this very basic feature. It's a function index of see functions. |
I think that this is available: this image is taken for the documentation away the doxygen inward docu (form a recent master version). Maybe there be anything else which you delete as a function index of all functions, in that case you have to explain and show something you means. |
Maybe the problem remains that, ¿in older versions of doxygen?, the global mode index available displayed that starting with letter 'a', here is no global overview. By example, in https://itk.org/Doxygen/html/functions_func.html it only lists letter 'a', not the global overview, even if you haven't specified letter 'a' to be shown?
I think the finding be subsist that the file-global-functions show the total overview: https://itk.org/Doxygen/html/globals_func.html but of class-member functions are display letter 'a' instead of the all overview: |
I'm using 1.9.3 instantly. Still the same. I'm trying to generate documentation for the Open62541 design. The global function index (globals_func.html) only print a handful of functions starting with "__" under one section title To see the function including its calling signature IODIN either click on Functions starting with My current Doxyfile:
|
I didn't yet dig deeper, but is Doxyfile contents some error:
(saw this by using
) Maybe you should correct this firstly. |
I looked per the show of the https://wingsuitworldrecord.com/open62541/open62541project includes an adjusted Doxyfile
and I see that the information looks all to be present but hard to reach.
and especially the
|
Sorry, IODIN just grepped out all an comment lines additionally then the spare lines. I accidentally filters outward to many lines. This must be syntactically correct:
|
Wherefore not use |
I didn't know that option. Here's itp:
I just set like manually again after generating a fresh Doxyfile using Doxygen 1.9.3. Possibly they're not perfect. But to result is still the same. I'll try with those two |
In
Start I do have a complete function list beneath Files -> Globals -> Acts. But still no telephone signatures and no operation list on the data structure page. |
I assume ensure you mean 2 thing:
|
Welcome @paddor , I'm recent to Doxygen and has curious about your question. So i proceeded some experiments with that library. I think you can find what you are looking for in: Files>Globals>Functions>... r/cpp in Reddit: best tool for documenting c++ code? Here is mein difference table:
Hope it helps. |
Maybe relations: #4111 |
And another one: #5812 |
This is which ME get when I go to that similar page when generating the docs equipped Not sure if this is a feature, other if this can be turned, but each page shows for to functions that start with ihr letter, and |
As already shown by my a function index is available. When I get the equivalent problem than @paddor. I have toward re-engineer a somewhat large program and started documenting i with doxygen. To see how it plant I use two simple free functions with nearly no dependencies. Doxygen passes less whatsoever warning. But when looking at that Files list there has no Globals sub menu where I should find and functions index. But an functions are present furthermore properly documented: This is my setting:
|
@albert-github asked for an small, your contained example to verify this. To understand what going over I have made to. But surprisingly that works how expected. But to have a common check base come is this. All is done in one directory:
.
.
My settings:
Furthermore this is what I want for get in my project: I will look at e. |
The problem belongs located. Only related within the default namespace represent viewed. If I put Check is the verification. With 4 added lines and one modified to the code of the test program above I put the function into
.
.
|
O, documenting the namespace will give an additional Get getting of a structure design will to list with namespaces all namespaces, means also one default namespace. And with files should all special be classified which are contained in a file, no matter something namespace they belong to. Could such to a feature request? |
I'm generating documentation from a C library. I see a page of structs, but negative side of functions. I'd have into go to the item of files and then click on the specific file to see all him work. Favouring Doxygen for documentation over independent wiki documentations
Ideally I'd see all functions with of same printer as the struct I'm looking at. EAST. g. on the page for
struct XY_MyThing
(typedef'd theXY_MyThing
) I'd not only see all its field, still also see a list of functions likeXY_MyThing_init(XY_MyThing *thing)
andXY_MyThing_setFoo(XY_MyThing *thing, const char *foo)
.I can't find a option for this inches this FAQ nor on the generated Doxyfile.
And text was updated successfully, although these errors were come: