Skip to content

Commit 6402864

Browse files
committed
doxygen: add/replace some occurences of \verbatim with \code
1 parent 5f11c33 commit 6402864

File tree

4 files changed

+12
-11
lines changed

4 files changed

+12
-11
lines changed

python/core/qgscoordinatereferencesystem.sip

+2-2
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ class QgsCoordinateReferenceSystem
192192
bool readXML( QDomNode & theNode );
193193
/*! Stores state to the given Dom node in the given document.
194194
* Below is an example of the generated tag.
195-
\verbatim
195+
\code{.xml}
196196
<spatialrefsys>
197197
<proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
198198
<srsid>2585</srsid>
@@ -202,7 +202,7 @@ class QgsCoordinateReferenceSystem
202202
<projectionacronym>longlat</projectionacronym>
203203
<ellipsoidacronym>WGS84</ellipsoidacronym>
204204
</spatialrefsys>
205-
\endverbatim
205+
\endcode
206206
* @param theNode The node in which state will be restored
207207
* @param theDoc The document in which state will be stored
208208
* @return bool True on success, False on failure

src/core/qgscoordinatereferencesystem.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
237237
bool readXML( QDomNode & theNode );
238238
/*! Stores state to the given Dom node in the given document.
239239
* Below is an example of the generated tag.
240-
\verbatim
240+
\code{.xml}
241241
<spatialrefsys>
242242
<proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
243243
<srsid>2585</srsid>
@@ -247,7 +247,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
247247
<projectionacronym>longlat</projectionacronym>
248248
<ellipsoidacronym>WGS84</ellipsoidacronym>
249249
</spatialrefsys>
250-
\endverbatim
250+
\endcode
251251
* @param theNode The node in which state will be restored
252252
* @param theDoc The document in which state will be stored
253253
* @return bool True on success, False on failure

src/core/qgsexpression.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Class for parsing and evaluation of expressions (formerly called "search strings
3838
The expressions try to follow both syntax and semantics of SQL expressions.
3939
4040
Usage:
41-
41+
\code{.cpp}
4242
QgsExpression exp("gid*2 > 10 and type not in ('D','F'));
4343
if (exp.hasParserError())
4444
{
@@ -53,6 +53,7 @@ The expressions try to follow both syntax and semantics of SQL expressions.
5353
{
5454
// examine the result
5555
}
56+
\endcode
5657
5758
Possible QVariant value types:
5859
- invalid (null)

src/core/qgsproject.cpp

+6-6
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ properties tags for all optional properties. Within that there will be scope
457457
tags. In the following example there exist one property in the "fsplugin"
458458
scope. "layers" is a list containing three string values.
459459
460-
\verbatim
460+
\code{.xml}
461461
<properties>
462462
<fsplugin>
463463
<foo type="int" >42</foo>
@@ -473,7 +473,7 @@ scope. "layers" is a list containing three string values.
473473
</feature_types>
474474
</fsplugin>
475475
</properties>
476-
\endverbatim
476+
\endcode
477477
478478
@param doc xml document
479479
@param project_properties should be the top QgsPropertyKey node.
@@ -559,10 +559,10 @@ _getProperties( QDomDocument const &doc, QgsPropertyKey & project_properties )
559559
Get the project title
560560
561561
XML in file has this form:
562-
\verbatim
562+
\code{.xml}
563563
<qgis projectname="default project">
564564
<title>a project title</title>
565-
\endverbatim
565+
\endcode
566566
567567
@todo XXX we should go with the attribute xor title, not both.
568568
*/
@@ -634,7 +634,7 @@ static QgsProjectVersion _getVersion( QDomDocument const &doc )
634634
635635
@note XML of form:
636636
637-
\verbatim
637+
\code{.xml}
638638
<maplayer type="vector">
639639
<layername>Hydrop</layername>
640640
<datasource>/data/usgs/city_shp/hydrop.shp</datasource>
@@ -669,7 +669,7 @@ static QgsProjectVersion _getVersion( QDomDocument const &doc )
669669
<alignment value="center" field="" />
670670
</labelattributes>
671671
</maplayer>
672-
\endverbatim
672+
\endcode
673673
*/
674674
QPair< bool, QList<QDomNode> > QgsProject::_getMapLayers( QDomDocument const &doc )
675675
{

0 commit comments

Comments
 (0)