Skip to content

Commit 06a53e1

Browse files
nyalldawsonnyalldawson
committedApr 3, 2017
/*! -> /**
We already have enough doxygen styles to manage!
·
ltr-3_40final-3_0_0
1 parent 676dc1a commit 06a53e1

21 files changed

+79
-180
lines changed
 

‎src/app/pluginmanager/qgspluginmanager.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ const int PLUGMAN_TAB_UPGRADEABLE = 3;
3939
const int PLUGMAN_TAB_NEW = 4;
4040
const int PLUGMAN_TAB_INVALID = 5;
4141

42-
/*!
42+
/**
4343
* \brief Plugin manager for browsing, (un)installing and (un)loading plugins
4444
*/
4545
class QgsPluginManager : public QgsOptionsDialogBase, private Ui::QgsPluginManagerBase

‎src/app/pluginmanager/qgspluginsortfilterproxymodel.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ const int SPACER_ROLE = Qt::UserRole + 20; // for sorting
3535

3636

3737

38-
/*!
38+
/**
3939
* \brief Proxy model for filtering and sorting items in Plugin Manager
4040
*/
4141
class QgsPluginSortFilterProxyModel : public QSortFilterProxyModel

‎src/app/qgsoptions.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ class APP_EXPORT QgsOptions : public QgsOptionsDialogBase, private Ui::QgsOption
7373
void on_pbnEditPyramidsOptions_pressed();
7474
void editGdalDriver( const QString &driverName );
7575
void saveOptions();
76-
/*!
76+
77+
/**
7778
* Slot to reset any temporarily applied options on dialog close/cancel */
7879
void rejectOptions();
7980
//! Slot to change the theme this is handled when the user

‎src/app/qgsprojectproperties.cpp

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1281,23 +1281,14 @@ void QgsProjectProperties::srIdUpdated()
12811281
}
12821282
}
12831283

1284-
/*!
1285-
* Function to save non-base dialog states
1286-
*/
12871284
void QgsProjectProperties::saveState()
12881285
{
12891286
}
12901287

1291-
/*!
1292-
* Function to restore non-base dialog states
1293-
*/
12941288
void QgsProjectProperties::restoreState()
12951289
{
12961290
}
12971291

1298-
/*!
1299-
* Set WMS default extent to current canvas extent
1300-
*/
13011292
void QgsProjectProperties::on_pbnWMSExtCanvas_clicked()
13021293
{
13031294
QgsRectangle ext = mMapCanvas->extent();

‎src/app/qgsprojectproperties.h

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
4747

4848
~QgsProjectProperties();
4949

50-
/*!
50+
/**
5151
Every project has a title
5252
*/
5353
QString title() const;
@@ -57,12 +57,13 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
5757
QString projectionWkt();
5858

5959
public slots:
60-
/*!
60+
61+
/**
6162
* Slot called when apply button is pressed or dialog is accepted
6263
*/
6364
void apply();
6465

65-
/*!
66+
/**
6667
* Slot to show the projections tab when the dialog is opened
6768
*/
6869
void showProjectionsTab();
@@ -84,8 +85,8 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
8485
//! A scale in the list of project scales changed
8586
void scaleItemChanged( QListWidgetItem *changedScaleItem );
8687

87-
/*!
88-
* Slots for WMS project settings
88+
/**
89+
* Set WMS default extent to current canvas extent
8990
*/
9091
void on_pbnWMSExtCanvas_clicked();
9192
void on_pbnWMSAddSRS_clicked();
@@ -98,24 +99,24 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
9899
void on_mWMSInspireScenario1_toggled( bool on );
99100
void on_mWMSInspireScenario2_toggled( bool on );
100101

101-
/*!
102+
/**
102103
* Slots to select/deselect all the WFS layers
103104
*/
104105
void on_pbnWFSLayersSelectAll_clicked();
105106
void on_pbnWFSLayersDeselectAll_clicked();
106107

107-
/*!
108+
/**
108109
* Slots to select/deselect all the WCS layers
109110
*/
110111
void on_pbnWCSLayersSelectAll_clicked();
111112
void on_pbnWCSLayersDeselectAll_clicked();
112113

113-
/*!
114+
/**
114115
* Slots to launch OWS test
115116
*/
116117
void on_pbnLaunchOWSChecker_clicked();
117118

118-
/*!
119+
/**
119120
* Slots for Styles
120121
*/
121122
void on_pbtnStyleManager_clicked();
@@ -126,22 +127,22 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
126127
void on_mTransparencySlider_valueChanged( int value );
127128
void on_mTransparencySpinBox_valueChanged( int value );
128129

129-
/*!
130+
/**
130131
* Slot to show the context help for this dialog
131132
*/
132133
void on_buttonBox_helpRequested() { QgsHelp::openHelp( QStringLiteral( "introduction/qgis_configuration.html#project-properties" ) ); }
133134

134-
/*!
135+
/**
135136
* Slot to link WFS checkboxes
136137
*/
137138
void cbxWFSPubliedStateChanged( int aIdx );
138139

139-
/*!
140+
/**
140141
* Slot to link WCS checkboxes
141142
*/
142143
void cbxWCSPubliedStateChanged( int aIdx );
143144

144-
/*!
145+
/**
145146
* If user changes the CRS, set the corresponding map units
146147
*/
147148
void srIdUpdated();
@@ -180,17 +181,17 @@ class APP_EXPORT QgsProjectProperties : public QgsOptionsDialogBase, private Ui:
180181
void populateStyles();
181182
void editSymbol( QComboBox *cbo );
182183

183-
/*!
184+
/**
184185
* Function to save non-base dialog states
185186
*/
186187
void saveState();
187188

188-
/*!
189+
/**
189190
* Function to restore non-base dialog states
190191
*/
191192
void restoreState();
192193

193-
/*!
194+
/**
194195
* Reset the Python macros
195196
*/
196197
void resetPythonMacros();

‎src/core/qgsapplication.cpp

Lines changed: 2 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -104,19 +104,6 @@ const char *QgsApplication::QGIS_APPLICATION_NAME = "QGIS3";
104104

105105
QgsApplication::ApplicationMembers *QgsApplication::sApplicationMembers = nullptr;
106106

107-
/*!
108-
\class QgsApplication
109-
\brief The QgsApplication class manages application-wide information.
110-
111-
This is a subclass of QApplication and should be instantiated in place of
112-
QApplication. Most methods are static in keeping with the design of QApplication.
113-
114-
This class hides platform-specific path information and provides
115-
a portable way of referencing specific files and directories.
116-
Ideally, hard-coded paths should appear only here and not in other modules
117-
so that platform-conditional code is minimized and paths are easier
118-
to change due to centralization.
119-
*/
120107
QgsApplication::QgsApplication( int &argc, char **argv, bool GUIenabled, const QString &customConfigPath, const QString &platformName )
121108
: QApplication( argc, argv, GUIenabled )
122109
{
@@ -489,16 +476,11 @@ QPixmap QgsApplication::getThemePixmap( const QString &name )
489476
}
490477
}
491478

492-
/*!
493-
Set the theme path to the specified theme.
494-
*/
495479
void QgsApplication::setThemeName( const QString &themeName )
496480
{
497481
ABISYM( mThemeName ) = themeName;
498482
}
499-
/*!
500-
* Get the active theme name
501-
*/
483+
502484
QString QgsApplication::themeName()
503485
{
504486
return ABISYM( mThemeName );
@@ -583,16 +565,11 @@ QHash<QString, QString> QgsApplication::uiThemes()
583565
return mapping;
584566
}
585567

586-
/*!
587-
Returns the path to the authors file.
588-
*/
589568
QString QgsApplication::authorsFilePath()
590569
{
591570
return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/AUTHORS" );
592571
}
593-
/*!
594-
Returns the path to the contributors file.
595-
*/
572+
596573
QString QgsApplication::contributorsFilePath()
597574
{
598575
return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/CONTRIBUTORS" );
@@ -602,17 +579,11 @@ QString QgsApplication::developersMapFilePath()
602579
return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/developersmap.html" );
603580
}
604581

605-
/*!
606-
Returns the path to the sponsors file.
607-
*/
608582
QString QgsApplication::sponsorsFilePath()
609583
{
610584
return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/SPONSORS" );
611585
}
612586

613-
/*!
614-
Returns the path to the donors file.
615-
*/
616587
QString QgsApplication::donorsFilePath()
617588
{
618589
return ABISYM( mPkgDataPath ) + QStringLiteral( "/doc/DONORS" );
@@ -704,9 +675,6 @@ QString QgsApplication::srsDatabaseFilePath()
704675
}
705676
}
706677

707-
/*!
708-
Returns the paths to the svg directories.
709-
*/
710678
QStringList QgsApplication::svgPaths()
711679
{
712680
//local directories to search when looking for an SVG with a given basename
@@ -730,9 +698,6 @@ QStringList QgsApplication::svgPaths()
730698
return paths;
731699
}
732700

733-
/*!
734-
Returns the paths to the composer template directories.
735-
*/
736701
QStringList QgsApplication::composerTemplatePaths()
737702
{
738703
//local directories to search when looking for an SVG with a given basename

‎src/core/qgsapplication.h

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ class QgsAnnotationRegistry;
4343
/** \ingroup core
4444
* Extends QApplication to provide access to QGIS specific resources such
4545
* as theme paths, database paths etc.
46+
*
47+
* This is a subclass of QApplication and should be instantiated in place of
48+
QApplication. Most methods are static in keeping with the design of QApplication.
49+
50+
This class hides platform-specific path information and provides
51+
a portable way of referencing specific files and directories.
52+
Ideally, hard-coded paths should appear only here and not in other modules
53+
so that platform-conditional code is minimized and paths are easier
54+
to change due to centralization.
4655
*/
4756

4857
class CORE_EXPORT QgsApplication : public QApplication
@@ -142,7 +151,7 @@ class CORE_EXPORT QgsApplication : public QApplication
142151
*/
143152
static QString translatorsFilePath();
144153

145-
/*!
154+
/**
146155
Returns the path to the licence file.
147156
*/
148157
static QString licenceFilePath();

‎src/core/qgscoordinatereferencesystem.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ class CORE_EXPORT QgsCoordinateReferenceSystem
204204

205205
~QgsCoordinateReferenceSystem();
206206

207-
/*!
207+
/**
208208
* Constructs a CRS object from a string definition using createFromString()
209209
*
210210
* It supports the following formats:

‎src/core/qgscoordinatetransform.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -74,22 +74,22 @@ class CORE_EXPORT QgsCoordinateTransform
7474

7575
~QgsCoordinateTransform();
7676

77-
/*!
77+
/**
7878
* Returns true if the coordinate transform is valid, ie both the source and destination
7979
* CRS have been set and are valid.
8080
* \since QGIS 3.0
8181
*/
8282
bool isValid() const;
8383

84-
/*!
84+
/**
8585
* Sets the source coordinate reference system.
8686
* \param crs CRS to transform coordinates from
8787
* \see sourceCrs()
8888
* \see setDestinationCrs()
8989
*/
9090
void setSourceCrs( const QgsCoordinateReferenceSystem &crs );
9191

92-
/*!
92+
/**
9393
* Sets the destination coordinate reference system.
9494
* \param crs CRS to transform coordinates to
9595
* \see destinationCrs()

‎src/gui/attributetable/qgsfeaturelistview.cpp

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -219,12 +219,6 @@ void QgsFeatureListView::repaintRequested()
219219
setDirtyRegion( viewport()->rect() );
220220
}
221221

222-
/*!
223-
This function is called with the given \a event when a mouse move event is
224-
sent to the widget. If a selection is in progress and new items are moved
225-
over the selection is extended; if a drag is in progress it is continued.
226-
*/
227-
228222
void QgsFeatureListView::mouseMoveEvent( QMouseEvent *event )
229223
{
230224
QPoint pos = event->pos();
@@ -241,13 +235,6 @@ void QgsFeatureListView::mouseMoveEvent( QMouseEvent *event )
241235
}
242236
}
243237

244-
/*!
245-
This function is called with the given \a event when a mouse button is released,
246-
after a mouse press event on the widget. If a user presses the mouse inside your
247-
widget and then drags the mouse to another location before releasing the mouse button,
248-
your widget receives the release event. The function will emit the clicked() signal if an
249-
item was being pressed.
250-
*/
251238
void QgsFeatureListView::mouseReleaseEvent( QMouseEvent *event )
252239
{
253240
Q_UNUSED( event );

‎src/gui/qgisgui.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class QFont;
3131
namespace QgisGui
3232
{
3333

34-
/*!
34+
/**
3535
* /var ModalDialogFlags
3636
* /brief Flags used to create a modal dialog (adapted from QMessageBox).
3737
*

‎src/gui/qgsconfigureshortcutsdialog.cpp

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,12 @@ QgsConfigureShortcutsDialog::~QgsConfigureShortcutsDialog()
5959
saveState();
6060
}
6161

62-
/*!
63-
* Function to save dialog window state
64-
*/
6562
void QgsConfigureShortcutsDialog::saveState()
6663
{
6764
QgsSettings settings;
6865
settings.setValue( QStringLiteral( "Windows/ShortcutsDialog/geometry" ), saveGeometry() );
6966
}
7067

71-
/*!
72-
* Function to restore dialog window state
73-
*/
7468
void QgsConfigureShortcutsDialog::restoreState()
7569
{
7670
QgsSettings settings;

0 commit comments

Comments
 (0)
Please sign in to comment.