- Table of Contents
- 1. What is SrcDoc?
- 2. Basic comment formatting
- 3. Invoking SrcDoc
- 4. Dependencies
- 5. Profiles
- 6. Command line options
- 6.1. -o, --output-directory=DIR
- 6.2. -s, --source-directory=DIR
- 6.3. -f, --format=FORMAT
- 6.4. -l, --language=LANG
- 6.5. -p, --profile=PROF
- 6.6. -c, --comment-parser=PARSER
- 6.7. -d, --dependencies
- 6.8. -b, --beautify-comments
- 6.9. -t, --title=TITLE
- 6.10. -i, --implementation-info=on/off
- 6.11. --protected=on/off
- 6.12. --private=on/off
- 6.13. --table-border=on/off
- 6.14. --skip-separators=on/off
- 6.15. -j, --join-comments=on/off
- 6.16. --fetch-comments=on/off
- 6.17. --synopsis=on/off
- 6.18. -v, --verbose
- 6.19. -q, --quiet, --silent
- 6.20. -h, --help
- 6.21. --version
- 7. Comment commands
- 7.1. Note
- 7.2. Alphabetical list of commands
- 7.2.1. <xxx>
- 7.2.2. _xxx_
- 7.2.3. \
char - 7.2.4. @<xxx>
- 7.2.5. @c, @code
- 7.2.6. @discard-subsequent-commands, @discard-commands
- 7.2.7. @discard-recent-comment, @discard-recent-comments, @discard-comment
- 7.2.8. @e
word, @emp word, @emphasis word @emphasis(text) - 7.2.9. @ec, @end-code
- 7.2.10. @fetch-related
- 7.2.11. @heading one_word_heading size, @heading(heading, size), @heading(heading)
- 7.2.12. @ignore-declarations n
- 7.2.13. @include-declarations n
- 7.2.14. @id name, @identifier name
- 7.2.15. @kw arg, @keyword arg
- 7.2.16. @link dest, @link(dest,label)
- 7.2.17. @linkfile dest, @linkfile(dest,label), @lf dest, @lf(dest,label)
- 7.2.18. @nl, @newline
- 7.2.19. @no-description
- 7.2.20. @para, @para(heading)
- 7.2.21. @param param_name [-] param_description...
- 7.2.22. @pre ... @endpre
- 7.2.23. @profile
profile_name, @profile(profile_names), @profiles(profile_names) - 7.2.24. @see [block]
- 7.2.25. @synopsis [block]
- 7.2.26. @title(title)
- 7.2.27. @until-next-comment
- 7.3. Comment-start Commands
- 7.3.1. {@discard ... }
- 7.3.2. {@decl
declaration }