MkDoc reference manual

Table of contents Tutorial Tag index

MkDoc reference manual » Documentation format » Miscellaneous tags » @ifopt and @ifnopt tags

Introduction
1 Install
- 1.1 Requirements
- 1.2 Execution
- 1.3 GNU Emacs mode
2 Tutorial
- 2.1 Quick start
3 General usage
- 3.1 Documentation directory and files
- 3.2 Processing steps
- 3.3 Symbol identifiers
- 3.4 External libraries
4 Preprocessor
- 4.1 Preprocessor context
- 4.2 Conditional directives
5 Documentation format
- 5.1 Plain documentation tags
- 5.2 Code documentation tags
- 5.3 Miscellaneous tags
6 Output formats
- 6.1 Html output
- 6.2 LaTeX output
- 6.3 Texinfo output
- 6.4 Plain text output
- 6.5 Man page output
- 6.6 DocBook output
- 6.7 Rich Text Format output
- 6.8 reStructuredText output
7 Configuration options
8 Sample projects
Tag index
GNU Free Documentation License

@ifopt and @ifnopt tags

This tag starts a new conditional group which must be ended by an @end if tag. The group will be ignored if the given configuration option is not equal to one of the specified values. If no value is specified, "1" is assumed.

@ifnopt tests with negated condition.

See also @else tag.

Syntax [link]

@ifopt <option> [{<value> [| <value> | ...] }]
  ...
[ @else
  ... ]
@end if

Example [link]

@ifnopt hide_internal
  This document contains some library internal information intended
  for developers.
@end if

Valid XHTML 1.0 StrictGenerated by diaxen on Wed Jan 27 15:46:24 2021 using MkDoc