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

Reformat all Imath header comments to doxygen style #81

Merged
merged 5 commits into from
Feb 1, 2021

Commits on Jan 13, 2021

  1. Doxygen-style comments

    Signed-off-by: Cary Phillips <[email protected]>
    cary-ilm committed Jan 13, 2021
    Configuration menu
    Copy the full SHA
    dbaf0f8 View commit details
    Browse the repository at this point in the history

Commits on Jan 27, 2021

  1. Rewrite header comments in doxygen format

    - All methods now have comments
    - Some methods have been rearranged to fit into better logical groups
    
    Still to do:
    - Sphinx reports errors on some functions
    - half not yet commented
    
    Signed-off-by: Cary Phillips <[email protected]>
    cary-ilm committed Jan 27, 2021
    Configuration menu
    Copy the full SHA
    89848ca View commit details
    Browse the repository at this point in the history

Commits on Jan 31, 2021

  1. Remove @file/@brief doxygen comments

    Breathe/sphinx ignores @file doxygen comments, so they're now straight
    C++ comments intended for the reader of the header file. Where
    appropriate, relevent details are covered in the class/function
    doxygen comments.
    
    Also restores some comments lost in the translation, and fixes some typos.
    
    Signed-off-by: Cary Phillips <[email protected]>
    cary-ilm committed Jan 31, 2021
    Configuration menu
    Copy the full SHA
    505a2d4 View commit details
    Browse the repository at this point in the history
  2. Typo in ImathQuat.h: IMATH_CONSTEXPR14

    Signed-off-by: Cary Phillips <[email protected]>
    cary-ilm committed Jan 31, 2021
    Configuration menu
    Copy the full SHA
    af8fb45 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    0012118 View commit details
    Browse the repository at this point in the history