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.

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

Doxygen documentation needs review #24

Open
orlandini opened this issue Jun 24, 2019 · 0 comments
Open

Doxygen documentation needs review #24

orlandini opened this issue Jun 24, 2019 · 0 comments
Assignees
Labels

Comments

@orlandini
Copy link
Member

When trying to generate the Doxygen documentation from NeoPZ's root directory with the following command:
doxygen Doxyfile
Many errors were produced that prevented the ../neopz_html/html/index.html of being generated.

I've setup the Doxyfile to write warning logs on ../neopz_html/doxygen_log.txt. Many are the warnings, so I've silenced for now many of them that are not strictly necessary to be fixed at the current moment.

As a first effort in fixing this issue, I suggest searching the logs for the following terms:

  • reached end of file while inside a f$ block
    This warning means that a LaTeX formula inside the documentation was not properly closed. Its correct syntax is \f$ latex-code-here \f$, not $ latex-code-here $.
  • end of file while inside a group
    Probably there are issues regarding group openings ({@) and group closings (@}).

As discussed with @philippedevloo , I've tagged here people involved in some already identified projects that need fixing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants