New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add a switch to allow doxygen to process inlcude files in a specific path #9621
Comments
Please don't add external links as they might not persistent, but include the files in a zip or compressed tar file to the question).
|
doxygen version: tmp.zip Thanks for the heads up, I tried putting the folder directly in |
In the file
but the file Maybe have a look at the
|
Sorry, I wrote the wrong include path in the example file, the And sorry I didn't use the default configuration file name, the configuration file name in zip is |
Please create a new zip file with the |
I think I understand why, I was using the lzma method to compress the zip file, so some decompression software may not be able to read it correctly. |
I see from the new zip file quite a few more files. |
I have updated the contents of the zip file to make the |
Uh, just in case, if you parse the file with clang, clang will report 1000+ errors, but it's not a problem with the content of the file |
I think I understand a bit what you want and I don't think this is out of the box possible by doxygen as doxygen uses the include file information in the files where they are included but doesn't show their content with that file. For the later you have to add the files as separate files to
though this will not show all files in one go but as separate parts. I think that there are some possibilities though with the aid of filters,
maybe I can think of something based on this command. |
I wrote my own tool to generate such things: https://github.com/ELC-lang/Header_File_constructor |
OK I understand, so quite specific and dedicated for your project.
|
|
and this tool is in theory a generic pre-processor but processing only part of the content |
|
|
Is the following line:
the line used to obtain the file |
Yes! |
OK probably the following will work:
with
maybe you have to fiddle a bit with the path of the executable. (I think my Chinese is worse, as it is non-existent 😉) |
I've just tried the configuration method you mentioned for a while and it does automate the process of building all_defs.cpp before I run doxygen, but it doesn't look like the generated documentation content attributes the definitions of the different elements to the files indirectly contained in all_defs_ref.hpp but all_defs_ref.hpp itself. In the source code viewer provided on the documentation page, all_defs_ref.hpp is still a huge thing of tens of thousands of lines😢 |
To see what happens for this filter in doxygen try to run doxygen with some options:
The entire file tree, when I understand you correctly, would probably be obtained (without using the filter), when you use settings like:
|
So I should run doxygen twice, once to get the correct namespace classification and once to get the correct file tree? |
No you don't have to run doxygen twice you can also run
|
I don't think I can debug the config file to make doxygen produce the output I want, and I don't really understand what you are trying to do |
In #9621 (comment) I gave a recipe to run the filter (with the remark that you might need to fiddle around a bit with some paths). |
Sorry for the late reply, I think it might be because I didn't sleep well last night I'm not in the best shape right now with
I'll probably get some sleep and track these developments in about 10 hours |
https://github.com/ELC-lang/Header_File_constructor/releases/tag/v2.2 Header_File_constructor.exe %1 -s See you in ten hours!🥱😴 |
Doesn't look like the filter has been picked up, it is possible that the line should read:
or
or in this special case
|
with
The documentation was built successfully, although all_defs_ref.hpp is still tens of thousands of lines long |
Do I understand it correctly that the problem has been solved? |
Maybe I'm misrepresenting it, what I want is for doxygen to correctly process |
The
and this is fed through the For testing / debugging I would as the |
You're right, but all |
Describe the bug
I've been using doxygen to generate documentation for my project since yesterday and it's really great!
However, there are some incompatibilities with doxygen in the writing of my project that are causing me some problems, and I don't know how to configure it to solve these problems
First, here is the website I generated with doxygen:
https://elc-lang.github.io/ELC/
Let me take a snippet of code from my project here to illustrate the problem:
As you can see, my project uses a lot of includes (click here if you're curious about how many), and as far as I know doxygen only handles include definitions in namesapce
But my project pretty much uses includes to build the code, so I had to take a strange approach: I used a tool to pre-process the family of headers in my project that I wanted to document into a single file (it was close to 1mb in size) and then processed the full definition file with doxygen
Expected behavior
I wish there was a switch to allow doxygen to process inlcude files in a specific path normally!
Screenshots
The text was updated successfully, but these errors were encountered: