40 Commits

Author SHA1 Message Date
Juergen E. Fischer
cbf7b5c0df fix 7454d87 2016-04-14 01:02:52 +02:00
Juergen E. Fischer
7454d87d6a doxygen: include sha in PROJECT_NUMBER 2016-04-13 22:16:21 +02:00
Juergen E. Fischer
4815ebd5c2 doxygen: fix extra stylesheet path 2016-04-11 17:37:17 +02:00
Matthias Kuhn
e3bfec0d57 Merge pull request #2954 from tomchadwin/master
New custom CSS for https://qgis.org/api/
2016-04-08 14:12:29 +02:00
Tom Chadwin
03da61ddd4 Move CSS to /doc, clarify comment 2016-03-30 11:32:10 +01:00
Tom Chadwin
888b158d46 Doxyfile clarification/format tweak 2016-03-29 16:40:59 +01:00
Tom Chadwin
b2cbbe45e4 Edit Doxyfile to change colour scheme and use CSS
Also moved custom CSS to /cmake_templates
2016-03-29 16:39:44 +01:00
Matthias Kuhn
ee46ece2da QgsMapLayerModel: allow direct retrieval of map layer 2016-03-09 11:33:37 +01:00
Nyall Dawson
45eeb95d83 Revert 13f4081 and 2b7c5c1
Ensures that Travis is testing the same documentation coverage as
the actual docs are built using.
2016-01-14 12:22:19 +11:00
Matthias Kuhn
80c9d02f5e Doxygen take 2 2016-01-07 17:10:13 +01:00
Matthias Kuhn
2b7c5c1d1c Only skip *.cpp files for doc generation on travis 2016-01-07 13:34:45 +01:00
Matthias Kuhn
13f4081d07 Remove .cpp files from doxymentation
Remove .cpp files from the doxymentation. They are not
considered to be part of the public API, so no reason to scan them for
symbols which are not exported anyway.
2015-12-18 18:38:40 +01:00
Juergen E. Fischer
bf79ecc779 doxygen: enable dot multimode 2015-12-06 22:26:18 +01:00
Stéphane Brunner
c9f0d83aaf The plugin define the following methods:
* layerFilterExpression
  Return an additional filter, used in
  WMS/GetMap, WMS/GetFeatureInfo, WFS/GetFeature to filter the features
* layerFilterSubsetString
  Return an additional the subset string (typically SQL) filter.
  Faster than the layerFilterExpression but not supported on all the
  type of layer
* layerPermissions
  Change the rights on the layer per user (known by the plugin)
  Concern rights: publish, insert, update, delete.
  Mostly used in WFS/Transaction, and the publish in all requests.
* authorizedLayerAttributes
  Be able to show some attributes only for a subset of user
  Used in: WMS/GetFeatureInfo, WFS/GetFeature
* allowToEdit
  Be able to don't allow to edit a particular feature, in our case base
  on the Geometry
  Used in: WFS/Transaction
* cacheKey
  Cache key to used to create the capabilities cache, "" for no cache,
  shouldn't contains any "-", default to ""
2015-11-18 14:49:43 +01:00
Larry Shaffer
f58bd1a0bd [auth system] Add to API docs and fix warnings 2015-09-21 08:51:19 -06:00
elpaso
7c3190fe12 Added documentation and QgsServer to doxy template 2015-06-29 12:50:57 +02:00
Nyall Dawson
10e738ba5f Allow linking API docs to Qt docs through the use of qt doxygen tagfiles.
This is done using the new QT_TAG_FILE and QT_DOC_URL cmake options.
QT_TAG_FILE should be set to the path of the qt.tags tagfile. In ubuntu
this file is provided by the qt4-doc-html package, and is located at
/usr/share/qt4/doc/html/qt.tags
QT_DOC_URL should be currently set to http://doc.qt.io/qt-4.8/
2015-06-02 20:26:09 +10:00
Nyall Dawson
34298e2e04 Add geometry classes to API docs 2015-06-02 12:51:40 +10:00
Matthias Kuhn
680b1ced70 Followup 0f8f618
Accidentally merged an extra line
2015-05-30 18:20:07 +02:00
elpaso
0f8f6188b0 Added documentation and QgsServer to doxy template 2015-05-30 17:46:08 +02:00
Denis Rouzaud
4c65277ea8 doxygen: add missing gui directory for effects 2015-04-16 17:23:48 +02:00
Denis Rouzaud
d660acbfa3 doxygen: add effects directory 2015-04-13 16:44:13 +02:00
Juergen E. Fischer
b22be91ed4 include server plugin api in doxygen 2015-04-13 16:23:50 +02:00
Nyall Dawson
47488f280d Add unit test for API documentation coverage
This test checks that the coverage of the API docs does not drop
below a preset threshold (initially set at the current doc coverage)

If new members are added without documentation, then the coverage
will drop and this test will fail. Hopefully over time we can slowly
increase this threshold until documentation coverage reaches an
acceptable level.
2015-02-11 22:22:06 +11:00
Nyall Dawson
cd86710d87 Fix some warnings 2015-02-02 16:05:54 +11:00
Nyall Dawson
631341b56d Sort members in api docs 2014-11-11 19:44:09 +11:00
Martin Dobias
959c5660ca Revert "Doxygen: do not add "Definition at line N of XYZ.cpp" to each method"
This reverts commit 7ee05afd366cebf3c8f44354067c34223346f835.
2014-11-08 00:52:54 +07:00
Martin Dobias
7ee05afd36 Doxygen: do not add "Definition at line N of XYZ.cpp" to each method
This is another tweak meant to declutter the generated documentation
2014-09-08 12:31:17 +07:00
Martin Dobias
a4ce7fc82e Doxygen: Do not show private members, referenced by/references relations
This change should help to make the API docs less cluttered.
The above mentioned pieces of information are not very useful for people reading docs - and core developers have their IDEs for checking references.
2014-09-08 10:05:42 +07:00
Martin Dobias
8d598d4df1 Do not create collaboration diagrams in doxygen docs
The diagrams do not really add much value and do not highlight the important concepts
of classes, confusing the user and making things looks more complicated than they are
2014-09-06 14:09:15 +07:00
Juergen E. Fischer
9ce0ea3f65 doxygen: add new directories and fix warnings 2014-07-13 17:09:59 +02:00
Juergen E. Fischer
10c77a54d3 fix doxygen dot graph warning 2014-04-06 00:30:16 +02:00
Juergen Fischer
17e9999238 revert change of doxygen DOT_GRAPH_MAX_NODES 2013-09-24 21:57:10 +02:00
Juergen E. Fischer
16ddd3ab7c fix doxygen and unused warnings 2013-08-25 10:49:37 +02:00
Juergen E. Fischer
15539f34ce more Quantum GIS => QGIS updates 2013-05-30 16:19:19 +02:00
Juergen E. Fischer
27f65c2355 fix doxygen and 'unused' warnings 2013-04-13 19:08:21 +02:00
Juergen E. Fischer
2626df9320 fix doxygen warnings 2012-08-14 00:04:02 +02:00
Juergen E. Fischer
5504d397bc also update doxygen template (followup 22a4de4ea0) 2012-08-13 23:51:42 +02:00
Juergen E. Fischer
c56491b111 fix #4805:
- drop internal spatialite and internal spatialindex
- drop support for debian lenny (no system spatialindex/spatialite there)
2012-04-23 20:51:30 +02:00
jef
0cd4317bc0 [FEATURE] documentation improvements
replace AUTHORS, CONTRIBUTORS, DONORS, SPONSORS and TRANSLATOR with t2t version
in doc, run txt2tags within the build and install documentation.  Optionally
build and install api documentation


git-svn-id: http://svn.osgeo.org/qgis/trunk@15348 c8812cc2-4d05-0410-92ff-de0c093fc19c
2011-03-06 02:09:21 +00:00