forked from atomvm/AtomVM
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix
Warning doxygenfunction: Unable to resolve function
errors in docs
Doxygen has trouble creating documentation for functions that are declared in a header file and defined in an other `.h`, rather than `.c` file, or otherwise appear in multiple header files. This fixes two functions that were displaying warning messages inside the published documentation. The folowing pattern can be used in future cases that need to be explicitly ommited due to multiple appearences in header files: `#ifndef DOXYGEN_SKIP_SECTION` <code to be omitted> `#endif /* DOXYGEN_SKIP_SECTION */` Preferably with a short `/* comment */` trailing the `#ifndef` entry mentioning the file where the function is actually documented. Signed-off-by: Winford <winford@object.stream>
- Loading branch information
1 parent
528b5e9
commit a370831
Showing
5 changed files
with
21 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters