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

core: documentation: updated, improved, and completed doxygen comments #983

Merged
merged 7 commits into from
May 5, 2014

Conversation

OlegHahm
Copy link
Member

@OlegHahm OlegHahm commented Apr 7, 2014

Closes #948

@OlegHahm OlegHahm added this to the Release 2014.04 milestone Apr 7, 2014
@OlegHahm
Copy link
Member Author

OlegHahm commented Apr 7, 2014

For BS and BS_COND I'm not sure if we need them (any longer). They seem to be in core forever(TM), but I couldn't find a single user for them.

* @def BS_COND
* @brief Conditional setting of a bitmask
*
* @param[in] condition The condition to be checked
Copy link
Member

Choose a reason for hiding this comment

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

But the condition is also bitwise, isn't it?

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually I'm not 100% sure, but probably yes. I would still vote for removing these two macros.

Copy link
Contributor

Choose a reason for hiding this comment

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

👍 for deleting.

Copy link
Member Author

Choose a reason for hiding this comment

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

What I don't understand is the -

Copy link
Member

Choose a reason for hiding this comment

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

I've got the feeling it maybe should be ~, because two-compliment does not make any sense here, while one-compliment makes at least a little bit sense

Copy link
Contributor

Choose a reason for hiding this comment

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

Another reason to delete the macro. Maybe be made sense once, but since then we forgot the meaning ...

@miri64
Copy link
Member

miri64 commented Apr 7, 2014

Replace “task“ with “thread“ in sched.h:42 and sched.h:66?

@OlegHahm
Copy link
Member Author

OlegHahm commented Apr 8, 2014

Thanks for the comments. Updated.

@@ -1,5 +1,5 @@
/*
* Copyright (C) 2013 Freie Universität Berlin
* Copyright (C) 2014 Freie Universität Berlin
*
* This file subject to the terms and conditions of the GNU Lesser General
Copy link
Contributor

Choose a reason for hiding this comment

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

file is subject

@thomaseichinger
Copy link
Member

sched.h struct schedstat needs /**<

@OlegHahm
Copy link
Member Author

Updated.

@miri64
Copy link
Member

miri64 commented May 3, 2014

ACK.

@thomaseichinger
Copy link
Member

ACK, go when squashed

@OlegHahm
Copy link
Member Author

OlegHahm commented May 5, 2014

Squashed.

OlegHahm added a commit that referenced this pull request May 5, 2014
core: documentation: updated, improved, and completed doxygen comments
@OlegHahm OlegHahm merged commit 3ede45e into RIOT-OS:master May 5, 2014
@OlegHahm OlegHahm deleted the core_doxygen_update branch May 5, 2014 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: 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.

core: documentation: atomic.h attributes.h bitarithm.h sched.h
6 participants