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

Fix #17: Update function description blocks across OSAL #21

Merged
merged 1 commit into from
Oct 1, 2019

Commits on Sep 18, 2019

  1. Fix nasa#17: Update function description blocks across OSAL

    Update all block comments for OSAL functions to follow a
    consistent style and ensure correctness of the descriptions.
    
    - All documentation covering the specific details, inputs/outputs
    and return values should be on the function _declaration_, not the
    definition.
    
    - The definition should also contain a block comment for visual
    distinction in the source file, but should be brief and refer
    back to the prototype/declaration for detail.  Any detail information
    that was indicated only with the definition is moved to the
    declaration.
    
    - Add doxygen tags/markup to external/public API block comments
    and expand the descriptions of these functions where needed.
    
    - Add block comments to the internal API prototypes, but _not_
    as doxygen tags/markup.  Note these functions are internal use,
    not part of the public API, and are not necessarily intended
    to be stable across OSAL releases like the public API is.
    
    - Removed stray prototypes for functions where there was no
    actual definition/implementation.
    jphickey committed Sep 18, 2019
    Configuration menu
    Copy the full SHA
    d398dac View commit details
    Browse the repository at this point in the history