Comments (7)
Based on your comments and where they were leading - I managed to resolve the issue by changing the STRIP_FROM_PATH setting in doxygen to match what was being done by exhale (ie. everything up to and including project directory name). This has resolved the issue.
from exhale.
Hmm. Nested directories are (supposed to be) supported. So what this means is that Doxygen did not create a directory node for this. Or at least os.path.dirname(file)
did not result in the same name as any of the directories reported by Doxygen.
Is this code public? It could be a Doxygen config problem, a file documentation comment problem, or a bug in exhale. Doxygen does weird things on Windows where sometimes they report Windows paths and sometimes they report Unix paths. I thought I fixed all of those though.
If the project is not public, can you include the xml for both the file and the directory? I need to see what path names it's using
from exhale.
Unfortunately not a public project.
The relevant file structure is as follows:
Project/
docs/
conf.py
api/
doxygen/
build
.doxyfile
test/
utests/
include/
If I put the documented .h files from doxygen into utests/; I get the warning and subsequent problem.
If I then go an delete the test/ directory from the doxygen xml folder (both in index and the generated dir xml file), it displays in the html with a folder name of utests
I tried putting in a nested include and had the same issue/"fix"
Here's the xml.zip folder from the doxygen generation.
from exhale.
dir_9350652c807819cafbc8c3aca0b83c13.xml
<compounddef id="dir_9350652c807819cafbc8c3aca0b83c13" kind="dir">
<compoundname>C:/...workspace/M..._Test/include/includeAswell</compoundname>
<innerfile refid="_m_a_x..._8h">MAX....h</innerfile>
<!-- ... -->
<location file="C:/...workspace/M..._Test/include/includeAswell/"/>
- directory location is
include/includeAswell
<innerfile>
listed isMAX....h
(refid
in that file tells you what xml to look in for file,refid.xml
)
_m_a_x..._8h.xml
<location file="C:/...workspace/M..._Test/include/MAX....h"/>
</compounddef>
</doxygen>
- file definition says it's in
include/
, notinclude/includeAswell
That seems to be the conflict. So exhale gets confused about which directory to put it in. Did you put a comment like /** \file MAX....h */
at the top of the file? If so, try changing it to just /** \file */
without the filename in there?
"Could not find directory parent of file [bar.h] with location [Project\include\nestedInclude\bar.h]."
This seems to be the opposite of the reported message though, where this one the file said it was there in include/includeAswell
? Which file was bar.h
?
If you share the doxygen configuration you are using / the relevant section of conf.py
that sets up exhale I'm happy to take a look and see if anything stands out, but I'm hoping it's a /** \file */
mishap 🙂
from exhale.
Oops - I introduced that error by not doing a clean build :P Sorry! I removed the "includeAswell" directory and shifted the associated .h to the parent so the problem would just exist with the utests directory so it could be isolated.
Rather look at this.
dir_13e138d54eb8818da29c3992edef070a.xml
Is the one throwing the warning. It has an "Innerdir" of:
dir_347f78c5bf8b9dbad860aafd5b962aba.xml
Which has the 2 "innerfile"s that I get the warnings from. In this particular instance it states (for the .h file):
"Could not find directory parent of file [test_MAX31855K.h] with location [MAX31855K_Test\test\utests\test_MAX31855K.h"]
The \file issue did actually exist - funnily enough. But I adjusted to just have \file without the filename appended and nothing changed.
from exhale.
Hmmmmm ok this seems good, doxygen
is now producing valid stuff. I think the path stripping is the problem.
How are you calling doxygen
, specifically what do you set STRIP_FROM_PATH
as and what do you put for doxygenStripFromPath
in exhale_args
?
The path stripping logic is probably the cause here, I'm digging around right now....
from exhale.
Are you able to edit exhale
(just find exhale/graph.py
) and add this:
--- a/exhale/graph.py
+++ b/exhale/graph.py
@@ -1882,6 +1882,19 @@ class ExhaleRoot(object):
all_directories.sort()
+ err = StringIO()
+ err.write("\nDirectories\n")
+ err.write(("-" * 44) + "\n")
+ for d in all_directories:
+ err.write("- {0}\n".format(d.name))
+
+ err.write("\n\nFiles\n")
+ err.write(("-" * 44) + "\n")
+ for f in self.files:
+ err.write("- {0}\n".format(f.location))
+
+ raise RuntimeError(err.getvalue())
+
for f in self.files:
if not f.location:
sys.stderr.write(utils.critical(
Just shoving an error message in to see what's going on, I think the cause of what we're seeing here is something related to how the doxygenStripFromPath
gets taken out. When you make html
it'll fail with the error message, paste that back here. This one is kind of hard for me to test blindly :/
from exhale.
Related Issues (20)
- Operator>>, <<, -> overloading bug HOT 4
- Unable to resolve function HOT 1
- Warnings caused by missing newlines in exhale output HOT 3
- LaTeX in \f$ swallows \n newlines HOT 2
- Allow root file to be excluded and set filename of hierarchy files HOT 1
- Replace collapsible list JavaScript with details/summary HOT 1
- Does it work for C projects? HOT 1
- Module Index Error 404 page HOT 1
- Exhale seems to eat asterisk-chars '*' HOT 1
- Exhale does not find functions with weird data types
- Hard-coded 'Class' and 'Classes' even for C
- Allow fully qualified enum, class, structs titles
- Fixup packaging requirements HOT 8
- Windows path length issues HOT 4
- no coverage uploaded for master HOT 1
- KeyError: 'concept' when listing nodes to console HOT 1
- Problem with Sphinx 7
- Github action fails HOT 4
- You broke test_python.yaml you foo
- Fortran support may be broken HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from exhale.