Documentation | Add chapter on cpukit/stringto (#134)

Joel Sherrill (@joel) gitlab at rtems.org
Sun Feb 8 16:59:27 UTC 2026




Joel Sherrill commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/134#note_142195


Each related set of functionality has its own chapter. Those chapters on APIs follow a pattern which you should copy. Intro, background, operations, and functions. Each function has a subsection which also follows a pattern. On background, it is theory so there may not be much for this one except justifying why these exist. And operations is likely similarly small since showing how one pattern is used by callers for all types is likely enough.

We consider Doxygen as important but not the primary documentation.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/134#note_142195
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20260208/4a8d7128/attachment-0001.htm>


More information about the bugs mailing list