[PATCH 00/20] Apply new Doxygen guidelines

Sebastian Huber sebastian.huber at embedded-brains.de
Fri Nov 20 11:15:06 UTC 2020


Adjust some high level Doxygen groups and rework the Partition Manager
and Events according to the new Doxygen guidelines.

Sebastian Huber (20):
  doxygen: Rename Internal to Implementation
  doxygen: Use common syntax for groups
  libio: Move to RTEMS implementation group
  rtems: Canonicalize partition file documentation
  rtems: Update partition documentation
  rtems: Move _Partition_Allocate_buffer()
  rtems: Move _Partition_Free_buffer()
  rtems: Remove _Partition_Free()
  rtems: Remove _Partition_Destroy()
  rtems: Move _Partition_Is_buffer_valid()
  rtems: Move _Partition_Is_buffer_on_boundary()
  rtems: Move _Partition_Is_buffer_size_aligned()
  rtems: Move _Partition_Is_buffer_area_aligned()
  rtems: Move _Partition_Initialize()
  rtems: Move _Partition_Allocate()
  rtems: Canonicalize task event file documentation
  rtems: Remove unused EVENT_CURRENT
  rtems: Remove EVENT_SETS_NONE_PENDING
  rtems: Remove unused _Event_Timeout()
  rtems: Update event documentation

 bsps/shared/doxygen.h                    |   8 +-
 cpukit/doxygen.h                         |   4 +-
 cpukit/doxygen/top-level-groups.h        |  11 +-
 cpukit/include/rtems/confdefs.h          |   2 +-
 cpukit/include/rtems/extensionimpl.h     |   2 +-
 cpukit/include/rtems/libcsupport.h       |   2 +-
 cpukit/include/rtems/libio.h             |   2 +
 cpukit/include/rtems/posix/posixapi.h    |   2 +-
 cpukit/include/rtems/rtems/asrimpl.h     |   2 +-
 cpukit/include/rtems/rtems/attrimpl.h    |   2 +-
 cpukit/include/rtems/rtems/barrierimpl.h |   2 +-
 cpukit/include/rtems/rtems/dpmemimpl.h   |   2 +-
 cpukit/include/rtems/rtems/eventdata.h   |   9 +-
 cpukit/include/rtems/rtems/eventimpl.h   | 104 +++++++++-----
 cpukit/include/rtems/rtems/messageimpl.h |   2 +-
 cpukit/include/rtems/rtems/modesimpl.h   |   2 +-
 cpukit/include/rtems/rtems/objectimpl.h  |   2 +-
 cpukit/include/rtems/rtems/optionsimpl.h |   2 +-
 cpukit/include/rtems/rtems/partdata.h    |  94 ++++++++-----
 cpukit/include/rtems/rtems/partimpl.h    | 165 +++--------------------
 cpukit/include/rtems/rtems/ratemonimpl.h |   2 +-
 cpukit/include/rtems/rtems/regionimpl.h  |   2 +-
 cpukit/include/rtems/rtems/semimpl.h     |   2 +-
 cpukit/include/rtems/rtems/signalimpl.h  |   2 +-
 cpukit/include/rtems/rtems/statusimpl.h  |   2 +-
 cpukit/include/rtems/rtems/tasksimpl.h   |   2 +-
 cpukit/include/rtems/rtems/timerimpl.h   |   2 +-
 cpukit/include/rtems/score/object.h      |   2 +-
 cpukit/rtems/src/eventmp.c               |   8 +-
 cpukit/rtems/src/eventreceive.c          |   5 +-
 cpukit/rtems/src/eventseize.c            |   5 +-
 cpukit/rtems/src/eventsend.c             |   8 +-
 cpukit/rtems/src/eventsurrender.c        |   8 +-
 cpukit/rtems/src/part.c                  |   5 +-
 cpukit/rtems/src/partcreate.c            |  45 ++++++-
 cpukit/rtems/src/partdelete.c            |  12 +-
 cpukit/rtems/src/partgetbuffer.c         |  14 +-
 cpukit/rtems/src/partident.c             |   5 +-
 cpukit/rtems/src/partmp.c                |   5 +-
 cpukit/rtems/src/partreturnbuffer.c      |  52 ++++++-
 cpukit/rtems/src/systemeventreceive.c    |   5 +-
 cpukit/rtems/src/systemeventsend.c       |   5 +-
 42 files changed, 345 insertions(+), 274 deletions(-)

-- 
2.26.2



More information about the devel mailing list