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

Unbreak Doxygen configuration #559

Merged
merged 4 commits into from
Dec 4, 2019
Merged

Unbreak Doxygen configuration #559

merged 4 commits into from
Dec 4, 2019

Commits on Dec 3, 2019

  1. Unbreak Doxygen configuration

    PROJECT_NAME goes into the title, don't scream with ALL CAPS here.
    PROJECT_BRIEF also goes into the title. Trailing dots are not used
    in English titles and do not look good.
    
    JAVADOC_AUTOBRIEF set to YES because writing "@brief" is excessive
    and some members do not use it (resulting in missing short docs).
    
    OPTIMIZE_OUTPUT_FOR_C so that we don't have references to classes
    and things like that. We use Doxygen for Themis Core.
    
    TYPEDEF_HIDES_STRUCT set to YES because Themis code style uses
    typedefs instead of C tags, so we prefer to not mention them.
    
    INPUT should include the top-level README file and only Themis Core.
    USE_MDFILE_AS_MAINPAGE makes sure that README is displayed.
    FILE_PATTERNS have to be set explicitly, otherwise Doxygen does not
    see our source code.
    
    MACRO_EXPANSION, EXPAND_ONLY_PREDEF, and PREDEFINED are used to
    hide pervasive API exporting macros from Doxygen output.
    ilammy committed Dec 3, 2019
    Configuration menu
    Copy the full SHA
    eed5dde View commit details
    Browse the repository at this point in the history
  2. Doxygen-friendly deprecations

    Write these macros in a single line so that Doxygen preprocessor
    strips them and does not break function definitions because of that.
    ilammy committed Dec 3, 2019
    Configuration menu
    Copy the full SHA
    b79c8db View commit details
    Browse the repository at this point in the history

Commits on Dec 4, 2019

  1. Configuration menu
    Copy the full SHA
    13126ab View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    a73c803 View commit details
    Browse the repository at this point in the history