doxygen: add/replace some occurences of \verbatim with \code

qgis · Oct 25, 2014 · 6402864 · 6402864
1 parent 5f11c33
commit 6402864
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 11 deletions.
diff --git a/python/core/qgscoordinatereferencesystem.sip b/python/core/qgscoordinatereferencesystem.sip
@@ -192,7 +192,7 @@ class QgsCoordinateReferenceSystem
     bool readXML( QDomNode & theNode );
     /*! Stores state to the given Dom node in the given document.
      * Below is an example of the generated tag.
-     \verbatim
+     \code{.xml}
       <spatialrefsys>
           <proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
            <srsid>2585</srsid>
@@ -202,7 +202,7 @@ class QgsCoordinateReferenceSystem
            <projectionacronym>longlat</projectionacronym>
            <ellipsoidacronym>WGS84</ellipsoidacronym>
        </spatialrefsys>
-     \endverbatim
+     \endcode
      * @param theNode The node in which state will be restored
      * @param theDoc The document in which state will be stored
      * @return bool True on success, False on failure

diff --git a/src/core/qgscoordinatereferencesystem.h b/src/core/qgscoordinatereferencesystem.h
@@ -237,7 +237,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
     bool readXML( QDomNode & theNode );
     /*! Stores state to the given Dom node in the given document.
      * Below is an example of the generated tag.
-     \verbatim
+     \code{.xml}
       <spatialrefsys>
           <proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
            <srsid>2585</srsid>
@@ -247,7 +247,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
            <projectionacronym>longlat</projectionacronym>
            <ellipsoidacronym>WGS84</ellipsoidacronym>
        </spatialrefsys>
-     \endverbatim
+     \endcode
      * @param theNode The node in which state will be restored
      * @param theDoc The document in which state will be stored
      * @return bool True on success, False on failure

diff --git a/src/core/qgsexpression.h b/src/core/qgsexpression.h
@@ -38,7 +38,7 @@ Class for parsing and evaluation of expressions (formerly called "search strings
 The expressions try to follow both syntax and semantics of SQL expressions.
 
 Usage:
-
+\code{.cpp}
   QgsExpression exp("gid*2 > 10 and type not in ('D','F'));
   if (exp.hasParserError())
   {
@@ -53,6 +53,7 @@ The expressions try to follow both syntax and semantics of SQL expressions.
   {
     // examine the result
   }
+\endcode
 
 Possible QVariant value types:
 - invalid (null)

diff --git a/src/core/qgsproject.cpp b/src/core/qgsproject.cpp
@@ -457,7 +457,7 @@ properties tags for all optional properties.  Within that there will be scope
 tags.  In the following example there exist one property in the "fsplugin"
 scope.  "layers" is a list containing three string values.
 
-\verbatim
+\code{.xml}
 <properties>
   <fsplugin>
     <foo type="int" >42</foo>
@@ -473,7 +473,7 @@ scope.  "layers" is a list containing three string values.
     </feature_types>
   </fsplugin>
 </properties>
-\endverbatim
+\endcode
 
 @param doc xml document
 @param project_properties should be the top QgsPropertyKey node.
@@ -559,10 +559,10 @@ _getProperties( QDomDocument const &doc, QgsPropertyKey & project_properties )
    Get the project title
 
    XML in file has this form:
-\verbatim
+\code{.xml}
    <qgis projectname="default project">
    <title>a project title</title>
-\endverbatim
+\endcode
 
    @todo XXX we should go with the attribute xor title, not both.
 */
@@ -634,7 +634,7 @@ static QgsProjectVersion _getVersion( QDomDocument const &doc )
 
    @note XML of form:
 
-\verbatim
+\code{.xml}
    <maplayer type="vector">
       <layername>Hydrop</layername>
       <datasource>/data/usgs/city_shp/hydrop.shp</datasource>
@@ -669,7 +669,7 @@ static QgsProjectVersion _getVersion( QDomDocument const &doc )
          <alignment value="center" field="" />
       </labelattributes>
    </maplayer>
-\endverbatim
+\endcode
 */
 QPair< bool, QList<QDomNode> > QgsProject::_getMapLayers( QDomDocument const &doc )
 {