Skip to content

API Documentation fixes mainly in libmmgs.h, and a workaround for a Doxygen problem#253

Merged
Algiane merged 8 commits intoMmgTools:developfrom
mpotse:develop
Mar 11, 2024
Merged

API Documentation fixes mainly in libmmgs.h, and a workaround for a Doxygen problem#253
Algiane merged 8 commits intoMmgTools:developfrom
mpotse:develop

Conversation

@mpotse
Copy link
Copy Markdown
Contributor

@mpotse mpotse commented Mar 10, 2024

  • Added a \brief for every function in libmmgs.h
  • The usual language fixes
  • used \ref to get links for types and functions that appear in documentation
  • wrote a bit more detail about some functions
  • workaround for a Doxygen problem in common/inout.c : it saw an if() with a long function call in the condition as a function call itself and added "if" to the call graphs as if it was a function. I think it's also easier to read now.
    This should be my last grocery-list kind of PR, I'll get to more concentrated changes.

@Algiane Algiane added kind: enhancement enhancement to an existing feature part: documentation labels Mar 11, 2024
Copy link
Copy Markdown
Member

@Algiane Algiane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for all these improvements.

@Algiane Algiane merged commit b5b50f5 into MmgTools:develop Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind: enhancement enhancement to an existing feature part: documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants