Help: Format visibility property and variable documentation

Add reStructuredText markup appropriately.
This commit is contained in:
Brad King 2015-05-22 10:49:10 -04:00
parent 771f1b00dc
commit 50de5dbbf5
4 changed files with 13 additions and 18 deletions

View File

@ -3,8 +3,9 @@
Value for symbol visibility compile flags
The <LANG>_VISIBILITY_PRESET property determines the value passed in a
visibility related compile option, such as -fvisibility= for <LANG>.
The ``<LANG>_VISIBILITY_PRESET`` property determines the value passed in a
visibility related compile option, such as ``-fvisibility=`` for ``<LANG>``.
This property only has an affect for libraries and executables with
exports. This property is initialized by the value of the variable
CMAKE_<LANG>_VISIBILITY_PRESET if it is set when a target is created.
exports. This property is initialized by the value of the
:variable:`CMAKE_<LANG>_VISIBILITY_PRESET` variable if it is set when a
target is created.

View File

@ -3,9 +3,9 @@ VISIBILITY_INLINES_HIDDEN
Whether to add a compile flag to hide symbols of inline functions
The VISIBILITY_INLINES_HIDDEN property determines whether a flag for
hiding symbols for inline functions, such as -fvisibility-inlines-hidden,
The ``VISIBILITY_INLINES_HIDDEN`` property determines whether a flag for
hiding symbols for inline functions, such as ``-fvisibility-inlines-hidden``,
should be used when invoking the compiler. This property only has an affect
for libraries and executables with exports. This property is initialized by
the value of the :variable:`CMAKE_VISIBILITY_INLINES_HIDDEN` if it is set
when a target is created.
the value of the :variable:`CMAKE_VISIBILITY_INLINES_HIDDEN` variable if it
is set when a target is created.

View File

@ -1,8 +1,5 @@
CMAKE_<LANG>_VISIBILITY_PRESET
------------------------------
Default value for <LANG>_VISIBILITY_PRESET of targets.
This variable is used to initialize the <LANG>_VISIBILITY_PRESET
property on all the targets. See that target property for additional
information.
Default value for the :prop_tgt:`<LANG>_VISIBILITY_PRESET` target
property when a target is created.

View File

@ -1,8 +1,5 @@
CMAKE_VISIBILITY_INLINES_HIDDEN
-------------------------------
Default value for VISIBILITY_INLINES_HIDDEN of targets.
This variable is used to initialize the VISIBILITY_INLINES_HIDDEN
property on all the targets. See that target property for additional
information.
Default value for the :prop_tgt:`VISIBILITY_INLINES_HIDDEN` target
property when a target is created.