[rtems-central commit] spec: Do not document optimization macro

Sebastian Huber sebh at rtems.org
Wed Feb 3 05:28:01 UTC 2021


Module:    rtems-central
Branch:    master
Commit:    5f3d145d4651d704beca8c6c0a9cb91d3b268e71
Changeset: http://git.rtems.org/rtems-central/commit/?id=5f3d145d4651d704beca8c6c0a9cb91d3b268e71

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Tue Feb  2 11:13:13 2021 +0100

spec: Do not document optimization macro

Having multiple documentations for the same global name confuses
Doxygen.

---

 spec/rtems/clock/if/get-ticks-per-second-1.yml | 14 +++-----------
 1 file changed, 3 insertions(+), 11 deletions(-)

diff --git a/spec/rtems/clock/if/get-ticks-per-second-1.yml b/spec/rtems/clock/if/get-ticks-per-second-1.yml
index 7cfb850..6d00fb4 100644
--- a/spec/rtems/clock/if/get-ticks-per-second-1.yml
+++ b/spec/rtems/clock/if/get-ticks-per-second-1.yml
@@ -1,6 +1,5 @@
 SPDX-License-Identifier: CC-BY-SA-4.0 OR BSD-2-Clause
-brief: |
-  Gets the number of clock ticks per second configured for this application.
+brief: null
 copyrights:
 - Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
 - Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
@@ -15,16 +14,9 @@ links:
 - role: interface-placement
   uid: header
 name: rtems_clock_get_ticks_per_second
-notes: |
-  The number of clock ticks per second is defined indirectly by the
-  ${/acfg/if/microseconds-per-tick:/name} configuration option.
-
-  This macro is an optimized variant for C/C++ without a function call
-  overhead.
+notes: null
 params: []
 return:
-  return: |
-    Returns the number of clock ticks per second configured for this
-    application.
+  return: null
   return-values: []
 type: interface



More information about the vc mailing list