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

Sys: Adding defgroup to rpl.h #2714

Closed
wants to merge 1 commit into from

Conversation

kushalsingh007
Copy link
Member

- Adding @defgroup and @brief section to rpl.h
@kushalsingh007
Copy link
Member Author

Since I wasn't exactly sure what the exact content should be I thought opening a PR and having your feedback would be a better idea.
@gebart :Can you list out the one's that you were referring to in #2656 i.e the one's for which rpl headers are completely missing Doxygen comments,and the one's which have Doxygen commands, but inside normal comment blocks. I plan to make all those minor changes in this PR.

@@ -8,7 +8,11 @@
*/

/**
* @defgroup rpl RPL Header
Copy link
Member

Choose a reason for hiding this comment

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

According to #2422 this should be net_rpl. I also would remove the "Header". The other protocol implementations don't use it either: http://riot-os.org/api/group__net.html

@jnohlgard
Copy link
Member

@kushalsingh007

  • sys/net/include/rpl/rpl_dodag.h is missing everything
  • sys/net/include/rpl/rpl_of_manager.h has broken @file documentation
  • sys/net/include/rpl/rpl_structs.h is missing documentation for the data structures
  • sys/net/include/rpl/rpl_config.h is missing documentation for the macros and data types
  • sys/net/routing/rpl/of_mrhof.h has a filename after @file and has a closing brace (@}) for the @ingroup command placed too early, should be moved to near the end of the file.
  • sys/net/routing/rpl/of_of0.h has a filename after @file and is missing documentation

Edit: Added some more files

@jnohlgard jnohlgard added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation labels Mar 25, 2015
@OlegHahm OlegHahm force-pushed the master branch 3 times, most recently from 9f184dd to 45554bf Compare March 31, 2015 13:01
@cgundogan
Copy link
Member

@kushalsingh007 are you still working on this?

@kushalsingh007
Copy link
Member Author

@cgundogan : I do have some of these in my local repo , however for those which need entire documentation to be written, I am afraid I might not be the best person to write documentation for those one's. As I do not have the idea about those one's in the big picture.

Still, I think I'll try to put here whatever I have done soon ( once my exams end in 2 days), Thanks for the reminder :). I am sure I'll need some help from you guys though.

@cgundogan
Copy link
Member

I close this PR, because it references the former rpl implementation

@cgundogan cgundogan closed this Aug 17, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation 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.

4 participants