-
Notifications
You must be signed in to change notification settings - Fork 373
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
Clean-up Doxygen for all methods in headers #583
Comments
Here are the doxygen guidelines for iceoyx: https://github.com/eclipse-iceoryx/iceoryx/blob/master/doc/aspice_swe3_4/swe_docu_guidelines.md |
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
…es in dds folder Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 25, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 29, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 29, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 29, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 29, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Mar 30, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Apr 15, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Apr 15, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
Apr 15, 2021
Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
May 3, 2021
…' into iox-eclipse-iceoryx#583-clean-up-doxygen-in-dds Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
May 3, 2021
…class Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
pushed a commit
to boschglobal/iceoryx
that referenced
this issue
May 3, 2021
Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 update copyrights Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 fix review finding Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 fix warnings for dds folder Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 add doxygen for constexpr in logging header file Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 improve doxygen quality of gateway header files in dds folder Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 update copyright and delete all Function to Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 update copyright Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 fix warnings for dds folder Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 fix "propagate" in doxygen comments Signed-off-by: Manel Melaouhi <external.Manel.Melaouhi@de.bosch.com> iox-eclipse-iceoryx#583 fix comments Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Remove documentation for deleted methods Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Reword doxygen returns Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Fix typo Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Fix typo in brief Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Remove useless documentation Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Remove @return from getter/setter Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Update loadConfig comment Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com> iox-eclipse-iceoryx#583 Update ctor comment Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
May 3, 2021
…' into iox-eclipse-iceoryx#583-clean-up-doxygen-in-dds Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
to boschglobal/iceoryx
that referenced
this issue
May 3, 2021
…class Signed-off-by: Hintz Martin (XC-AD/ESB5) <martin.hintz@de.bosch.com>
marthtz
added a commit
that referenced
this issue
May 19, 2021
…-dds Iox #583 clean up doxygen in dds
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As discussed in the last iox dev meeting (2021-02-18) Doxygen comments for all methods in all headers need to be checked for completeness and cleaned-up if necessary.
It should look like this
Comment should have:
Ex1:
Ex2:
The text was updated successfully, but these errors were encountered: