Home
> e-infrastructure, service-is-documenting, service-is-testing-troubleshooting-debugging > How to define your own conditional content marker “Internal” for Doxygen
How to define your own conditional content marker “Internal” for Doxygen
- Doxygen comes with a built-in conditional content marker \internal the outputting of which can be controlled with the switch INTERNAL_DOCS in Doxygen’s config file.
- However, I could not get this to work as advertised in Doxygen 1.8.8.
- In cases of similar feature breakage, users are commonly advised to fix the error in the Doxygen source. If you, like I did, lack the time for that, here is a simple workaround which uses another built-in feature that an be controlled via Doxygen’s config file:
- Define as one of the:
ALIASES = "myinternal=\if myinternal <HR><kbd><em>" \ "endmyinternal= </em></kbd> \endif" # HTML is optional, intended to make internal information stand out clearly if outputted - Switch this ALIAS on and off using ENABLED_SECTIONS = # myinternal
- Example usage in a .dox file:
-# A high-low-high-low beep sequence followed by a low-high beep sequence indicates successful pairing and connection to the remote device. @myinternal tested with barcode on lower-end of cradle: gives success beep sequence @endmyinternal -# A long low, long high beep sequence indicates unsuccessful pairing.
Comments (0)
Trackbacks (0)
Leave a comment
Trackback
Questions? Read the About. Or just ask me a quick
FAQs for LRC student staff or for students or for teachers. To search our FAQs, in the browser addressbar, add after "https://plagwitz.wordpress.com/feed/?tag=faqs+/" "+TAG1" (from tag cloud below) OR "https://plagwitz.wordpress.com/feed/tag=faqs
&category_name=" "CAT1" (from category hierarchy below). OR search both categories and tags, and multiple TAGs/CATs (connect with "," for OR-search, with "+" for AND-search), like so: https://plagwitz.wordpress.com/feed/?tag=TAG1+TAG2+...TAGn&category_name=CAT1
+CAT2+...CATn"
Other ways to find help
If you cannot find it here, look there: 5,500 Language-Learning Links and Programs for learning or teaching 150 languages
Shortcuts:Our Lists, Our Maps, LRC Staff Moodle Site,LRC Project Moodle Site, 49erexpress, UNCC Moodle, Student Recordings: s:claslcslrcsanakostudent
Learning usage samples: Sanako oral exam, Kaltura webcam presentation, Dictation with speech recognition, Sanako written exam, Chinese and Japanese interactive stroke-order practice
Test the Sanako Installer, Webbrowser Popup Konfigurator for XP, or Windows7, faster LRC TeacherPC Log-in Let MS facilitate diacritics writing by installing for you US-International keyboard layout
This is my personal blog (Google+). The views expressed on these pages are mine alone and not those of my employer. The information in this weblog is provided “AS IS” with no warranties, and confers no rights.
Thomas' Work Space 