Skip to content

Commit 17500c4

Browse files
committed
Fix some interface doxygen
1 parent b6b08e9 commit 17500c4

File tree

2 files changed

+233
-3
lines changed

2 files changed

+233
-3
lines changed

python/gui/auto_generated/qgisinterface.sip.in

+115
Original file line numberDiff line numberDiff line change
@@ -167,38 +167,153 @@ Advanced digitizing dock widget
167167

168168

169169
virtual QMenu *projectMenu() = 0;
170+
%Docstring
171+
Returns a reference to the main window "Project" menu.
172+
%End
173+
170174
virtual QMenu *editMenu() = 0;
175+
%Docstring
176+
Returns a reference to the main window "Edit" menu.
177+
%End
178+
171179
virtual QMenu *viewMenu() = 0;
180+
%Docstring
181+
Returns a reference to the main window "View" menu.
182+
%End
183+
172184
virtual QMenu *layerMenu() = 0;
185+
%Docstring
186+
Returns a reference to the main window "Layer" menu.
187+
%End
188+
173189
virtual QMenu *newLayerMenu() = 0;
190+
%Docstring
191+
Returns a reference to the main window "Create New Layer" menu.
192+
%End
193+
174194
virtual QMenu *addLayerMenu() = 0;
175195
%Docstring
196+
Returns a reference to the main window "Add Layer" menu.
176197

177198
.. versionadded:: 2.5
178199
%End
200+
179201
virtual QMenu *settingsMenu() = 0;
202+
%Docstring
203+
Returns a reference to the main window "Settings" menu.
204+
%End
205+
180206
virtual QMenu *pluginMenu() = 0;
207+
%Docstring
208+
Returns a reference to the main window "Plugin" menu.
209+
%End
210+
181211
virtual QMenu *rasterMenu() = 0;
212+
%Docstring
213+
Returns a reference to the main window "Raster" menu.
214+
%End
215+
182216
virtual QMenu *databaseMenu() = 0;
217+
%Docstring
218+
Returns a reference to the main window "Database" menu.
219+
%End
220+
183221
virtual QMenu *vectorMenu() = 0;
222+
%Docstring
223+
Returns a reference to the main window "Vector" menu.
224+
%End
225+
184226
virtual QMenu *webMenu() = 0;
227+
%Docstring
228+
Returns a reference to the main window "Web" menu.
229+
%End
230+
185231
virtual QMenu *firstRightStandardMenu() = 0;
232+
%Docstring
233+
Returns a reference to the right most standard menu, which is
234+
usually the last menu item before the "Help" menu.
235+
236+
This can be used to insert additional top-level menus into
237+
their correct position BEFORE the help menu.
238+
%End
239+
186240
virtual QMenu *windowMenu() = 0;
241+
%Docstring
242+
Returns a reference to the main window "Window" menu.
243+
%End
244+
187245
virtual QMenu *helpMenu() = 0;
246+
%Docstring
247+
Returns a reference to the main window "Help" menu.
248+
%End
249+
188250

189251
virtual QToolBar *fileToolBar() = 0;
252+
%Docstring
253+
Returns a reference to the main window "File" toolbar.
254+
%End
255+
190256
virtual QToolBar *layerToolBar() = 0;
257+
%Docstring
258+
Returns a reference to the main window "Layer" toolbar.
259+
%End
260+
191261
virtual QToolBar *mapNavToolToolBar() = 0;
262+
%Docstring
263+
Returns a reference to the main window "Map Navigation" toolbar.
264+
%End
265+
192266
virtual QToolBar *digitizeToolBar() = 0;
267+
%Docstring
268+
Returns a reference to the main window "Digitize" toolbar.
269+
%End
270+
193271
virtual QToolBar *advancedDigitizeToolBar() = 0;
272+
%Docstring
273+
Returns a reference to the main window "Advanced Digitizing" toolbar.
274+
%End
275+
194276
virtual QToolBar *shapeDigitizeToolBar() = 0;
277+
%Docstring
278+
Returns a reference to the main window "Shape Digitizing" toolbar.
279+
280+
.. versionadded:: 3.0
281+
%End
282+
195283
virtual QToolBar *attributesToolBar() = 0;
284+
%Docstring
285+
Returns a reference to the main window "Attributes" toolbar.
286+
%End
287+
196288
virtual QToolBar *pluginToolBar() = 0;
289+
%Docstring
290+
Returns a reference to the main window "Plugin" toolbar.
291+
%End
292+
197293
virtual QToolBar *helpToolBar() = 0;
294+
%Docstring
295+
Returns a reference to the main window "Help" toolbar.
296+
%End
297+
198298
virtual QToolBar *rasterToolBar() = 0;
299+
%Docstring
300+
Returns a reference to the main window "Raster" toolbar.
301+
%End
302+
199303
virtual QToolBar *vectorToolBar() = 0;
304+
%Docstring
305+
Returns a reference to the main window "Vector" toolbar.
306+
%End
307+
200308
virtual QToolBar *databaseToolBar() = 0;
309+
%Docstring
310+
Returns a reference to the main window "Database" toolbar.
311+
%End
312+
201313
virtual QToolBar *webToolBar() = 0;
314+
%Docstring
315+
Returns a reference to the main window "Web" toolbar.
316+
%End
202317

203318
virtual QAction *actionNewProject() = 0;
204319
virtual QAction *actionOpenProject() = 0;

src/gui/qgisinterface.h

+118-3
Original file line numberDiff line numberDiff line change
@@ -184,42 +184,157 @@ class GUI_EXPORT QgisInterface : public QObject
184184
*/
185185
virtual QgsAdvancedDigitizingDockWidget *cadDockWidget() = 0;
186186

187-
/**
187+
/*
188188
* Accessors for inserting items into menus and toolbars.
189189
* An item can be inserted before any existing action.
190190
*/
191191

192-
// Menus
192+
/**
193+
* Returns a reference to the main window "Project" menu.
194+
*/
193195
virtual QMenu *projectMenu() = 0;
196+
197+
/**
198+
* Returns a reference to the main window "Edit" menu.
199+
*/
194200
virtual QMenu *editMenu() = 0;
201+
202+
/**
203+
* Returns a reference to the main window "View" menu.
204+
*/
195205
virtual QMenu *viewMenu() = 0;
206+
207+
/**
208+
* Returns a reference to the main window "Layer" menu.
209+
*/
196210
virtual QMenu *layerMenu() = 0;
211+
212+
/**
213+
* Returns a reference to the main window "Create New Layer" menu.
214+
*/
197215
virtual QMenu *newLayerMenu() = 0;
198-
//! \since QGIS 2.5
216+
217+
/**
218+
* Returns a reference to the main window "Add Layer" menu.
219+
* \since QGIS 2.5
220+
*/
199221
virtual QMenu *addLayerMenu() = 0;
222+
223+
/**
224+
* Returns a reference to the main window "Settings" menu.
225+
*/
200226
virtual QMenu *settingsMenu() = 0;
227+
228+
/**
229+
* Returns a reference to the main window "Plugin" menu.
230+
*/
201231
virtual QMenu *pluginMenu() = 0;
232+
233+
/**
234+
* Returns a reference to the main window "Raster" menu.
235+
*/
202236
virtual QMenu *rasterMenu() = 0;
237+
238+
/**
239+
* Returns a reference to the main window "Database" menu.
240+
*/
203241
virtual QMenu *databaseMenu() = 0;
242+
243+
/**
244+
* Returns a reference to the main window "Vector" menu.
245+
*/
204246
virtual QMenu *vectorMenu() = 0;
247+
248+
/**
249+
* Returns a reference to the main window "Web" menu.
250+
*/
205251
virtual QMenu *webMenu() = 0;
252+
253+
/**
254+
* Returns a reference to the right most standard menu, which is
255+
* usually the last menu item before the "Help" menu.
256+
*
257+
* This can be used to insert additional top-level menus into
258+
* their correct position BEFORE the help menu.
259+
*/
206260
virtual QMenu *firstRightStandardMenu() = 0;
261+
262+
/**
263+
* Returns a reference to the main window "Window" menu.
264+
*/
207265
virtual QMenu *windowMenu() = 0;
266+
267+
/**
268+
* Returns a reference to the main window "Help" menu.
269+
*/
208270
virtual QMenu *helpMenu() = 0;
209271

210272
// ToolBars
273+
274+
/**
275+
* Returns a reference to the main window "File" toolbar.
276+
*/
211277
virtual QToolBar *fileToolBar() = 0;
278+
279+
/**
280+
* Returns a reference to the main window "Layer" toolbar.
281+
*/
212282
virtual QToolBar *layerToolBar() = 0;
283+
284+
/**
285+
* Returns a reference to the main window "Map Navigation" toolbar.
286+
*/
213287
virtual QToolBar *mapNavToolToolBar() = 0;
288+
289+
/**
290+
* Returns a reference to the main window "Digitize" toolbar.
291+
*/
214292
virtual QToolBar *digitizeToolBar() = 0;
293+
294+
/**
295+
* Returns a reference to the main window "Advanced Digitizing" toolbar.
296+
*/
215297
virtual QToolBar *advancedDigitizeToolBar() = 0;
298+
299+
/**
300+
* Returns a reference to the main window "Shape Digitizing" toolbar.
301+
* \since QGIS 3.0
302+
*/
216303
virtual QToolBar *shapeDigitizeToolBar() = 0;
304+
305+
/**
306+
* Returns a reference to the main window "Attributes" toolbar.
307+
*/
217308
virtual QToolBar *attributesToolBar() = 0;
309+
310+
/**
311+
* Returns a reference to the main window "Plugin" toolbar.
312+
*/
218313
virtual QToolBar *pluginToolBar() = 0;
314+
315+
/**
316+
* Returns a reference to the main window "Help" toolbar.
317+
*/
219318
virtual QToolBar *helpToolBar() = 0;
319+
320+
/**
321+
* Returns a reference to the main window "Raster" toolbar.
322+
*/
220323
virtual QToolBar *rasterToolBar() = 0;
324+
325+
/**
326+
* Returns a reference to the main window "Vector" toolbar.
327+
*/
221328
virtual QToolBar *vectorToolBar() = 0;
329+
330+
/**
331+
* Returns a reference to the main window "Database" toolbar.
332+
*/
222333
virtual QToolBar *databaseToolBar() = 0;
334+
335+
/**
336+
* Returns a reference to the main window "Web" toolbar.
337+
*/
223338
virtual QToolBar *webToolBar() = 0;
224339

225340
// Project menu actions

0 commit comments

Comments
 (0)