Skip to content

doc: missing Doxygen generated documentation for any function which name starts with an underscore #11047

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

Closed
mnkp opened this issue Nov 2, 2018 · 2 comments
Assignees
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug

Comments

@mnkp
Copy link
Member

mnkp commented Nov 2, 2018

"Power Management Hook Interface" section of "Power Management APIs" is empty despite the fact that zephyr/include/power.h contains all necessary Doxygen comments.

Functions which should appear in this section are:

static inline void _sys_soc_pm_idle_exit_notification_disable(void);
void _sys_soc_resume_from_deep_sleep(void);
void _sys_soc_resume(void);
extern int _sys_soc_suspend(s32_t ticks);

It looks like Doxygen ignores all function names which start with an underscore.

@mnkp mnkp added bug The issue is a bug, or the PR is fixing a bug area: Documentation labels Nov 2, 2018
@mnkp mnkp changed the title doc: "Power Management Hook Interface" section of "Power Management APIs" is empty doc: missing Doxygen generated documentation for any function which name starts with an underscore Nov 9, 2018
@dbkinder
Copy link
Contributor

dbkinder commented Nov 10, 2018

This is a deliberate configuration of doxygen, added by PR #6280

@lpereira @nashif The assumption was that symbols with leading underscores "shouldn't be used by applications, as there's no guarantee they will be available in subsequent versions or maintain
API and ABI compatibility. Is this still true and the desired behavior of our API doc processing?

See also #6543 (Names that begin with an underscore are reserved by the C standard) #9882 (MISRA-C - Do not use reserved names).

@galak galak added priority: medium Medium impact/importance bug priority: low Low impact/importance bug and removed priority: medium Medium impact/importance bug labels Nov 20, 2018
@nashif nashif self-assigned this Nov 21, 2018
@nashif nashif assigned ramakrishnapallala and unassigned nashif and dbkinder Dec 7, 2018
@nashif
Copy link
Member

nashif commented Dec 7, 2018

@ramakrishnapallala I do not remember the history behind the naming, but those functions are being documented and appear in a public API, so they should not have _sys prefix. The _ should be removed from all public APIs and documented hooks. underscore should only be used for internal function calls.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation bug The issue is a bug, or the PR is fixing a bug priority: low Low impact/importance bug
Projects
None yet
Development

No branches or pull requests

5 participants