Doxygen Documentation: memory.h

embeddedartistry / libc

libc targeted for embedded systems usage. Reduced set of functionality (due to embedded nature). Chosen for portability and quick bringup.

MIT License

520 stars 67 forks source link

Closed phillipjohnston closed 6 years ago

phillipjohnston commented 6 years ago

include/memory.h needs Doxygen documentation added for each of the functions.

Please see embeddedartistry/libmemory or include/ctype.h as a reference for Doxygen function comments.

cppreference.com is a great resource to use for the functional descriptions.

To build the documentation, run make doc in the repository root. Documentation output is found at buildresults/doc/html/index.html.

seekaddo commented 6 years ago

@phillipjohnston the header file is empty. Do we need to reference the various function or any tipps on this.

phillipjohnston commented 6 years ago

I'll take care of this one quickly

seekaddo commented 6 years ago

Great