Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix Doxygen issues on Windows #7

Open
mbeyeler opened this issue Mar 5, 2017 · 0 comments
Open

Fix Doxygen issues on Windows #7

mbeyeler opened this issue Mar 5, 2017 · 0 comments
Labels
docathon documentation

Comments

@mbeyeler
Copy link
Member

mbeyeler commented Mar 5, 2017

Using Doxygen on Windows produces an error: Here is the error message when type "doxygen.exe CARLsim.config.doxy" in command prompt

Generating index page...
explicit link request to 'ch1_getting_started' in layout file 'CARLsimLayout.xml' could not be resolved
...

This might be caused by "@ref" in the layout file:

<tab type="usergroup" visible="yes" title="1. Getting Started" url="@ref ch1_getting_started">

Needs to be replaced with:

<tab type="usergroup" visible="yes" title="1. Getting Started" url="\\ref ch1_getting_started">

However, the double-backslash \\ doesn't work in Linux... There we need a single backslash.
Maybe we can have two different layout and config files; one for Windows, one for Unix.

Fix.
@mbeyeler mbeyeler modified the milestone: v3.1.3 Mar 7, 2017
@mbeyeler mbeyeler removed this from the v3.1.4 milestone Dec 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docathon documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mbeyeler