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

Update Doxygen doxyfile #903

Merged
merged 10 commits into from
Jul 5, 2024
Merged

Update Doxygen doxyfile #903

merged 10 commits into from
Jul 5, 2024

Commits on May 29, 2024

  1. doxygen: don't look in mythtv/contrib 

    Since 93e7287, it has been excluded by
EXCLUDE_PATTERNS.
    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    b69d15a View commit details
    Browse the repository at this point in the history

  2. doxyfile: enable FULL_PATH_NAMES 

    This makes it easier to see where a file is included.

STRIP_FROM_PATH        = ../../
makes all paths referenced to the root of the Git repository
(assuming doxygen is run in mythtv/docs/)
    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    1530b6f View commit details
    Browse the repository at this point in the history

  3. doxyfile: set STRIP_FROM_INC_PATH 

    This makes the recommended include line more useful on class documentation
pages.  Instead of listing just the filename, it gives a usable path for the
libraries and tells you which library, program, or plugin the class is in.
    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    b2daced View commit details
    Browse the repository at this point in the history

  4. doxyfile: increase LOOKUP_CACHE_SIZE

    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    68f69a5 View commit details
    Browse the repository at this point in the history

  5. doxyfile: extract anonymous namespaces

    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    db19d32 View commit details
    Browse the repository at this point in the history

  6. doxyfile: enable builtin STL support

    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    80e6d95 View commit details
    Browse the repository at this point in the history

  7. doxyfile: generate SVGs instead of PNGs

    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    af07757 View commit details
    Browse the repository at this point in the history

  8. docs: these are pages or sub-pages not groups

    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    7116ff0 View commit details
    Browse the repository at this point in the history

  9. doxyfile: update EXCLUDE_PATTERNS 

    All moc_*.(h|cpp) files are in a moc folder.
All obj folders are generated during build.
The i18n folders in mythplugins only contain generated files.

I considered adding:
*/external/*
but I'm leaving it for mythtranscode/external/replex

*/scripts/*
I don't think any of these are useful to doxygen, but I'm not sure.
    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    bd0a371 View commit details
    Browse the repository at this point in the history

  10. doxygen-architecture-document.cpp: silence doxygen warnings 

    402: warning: end of comment block while expecting command </em>
401: warning: found </em> tag without matching <em>

Also removed extraneous character preventing line break from working correctly.
    @ulmus-scott
    ulmus-scott committed May 29, 2024
    Configuration menu
    Copy the full SHA
    193ad67 View commit details
    Browse the repository at this point in the history