Skip to content

doc: add math group to Doxygen#9842

Merged
aabadie merged 5 commits intoRIOT-OS:masterfrom
jia200x:pr/doc_math
Aug 27, 2018
Merged

doc: add math group to Doxygen#9842
aabadie merged 5 commits intoRIOT-OS:masterfrom
jia200x:pr/doc_math

Conversation

@jia200x
Copy link
Copy Markdown
Member

@jia200x jia200x commented Aug 24, 2018

Contribution description

This is yet another PR for improving the documentation structure.

Here I group several math modulesin a Math libraries and utilities group, so they are easier to find for the end user.

A sys_math group was defined under sys group.

The following modules where touched and added to the corresponding groups:

  • sys/div.h: sys_math
  • sys/matstat: sys_math
  • sys/seq: sys_math
  • pkg/libfixmath: sys_math, pkg

Testing procedure

make doc.

Go to System>Math libraries and utilities in the generated documentation and see how these components are grouped.

Issues/PRs references

#8479

@jia200x jia200x requested review from aabadie and miri64 August 24, 2018 16:20
@jia200x jia200x added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Area: doc Area: Documentation Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation labels Aug 24, 2018
Copy link
Copy Markdown
Contributor

@aabadie aabadie left a comment

Choose a reason for hiding this comment

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

I built the documentation locally and this is all good.

ACK and go

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants