70 Commits

Author SHA1 Message Date
Denis Rouzaud
fcc0d7dde3 enhanced output for code_layout build on Travis 2017-07-24 13:40:49 +02:00
Harrissou Sant-anna
0d9945deac Use JavaScript instead of javascript/Javascript
+ update INSTALL doc
2017-07-13 17:40:55 +02:00
Nyall Dawson
fc221a6ebe Add sip VirtualCatcherCode to avoid algorithm copies being
destroyed by the python garbage collector

The code generated with the /Factory/ annotation was not sufficient
to correctly transfer the ownership of objects created in Python
back to c++ (despite mailing list messages which hint that it
is).

Anyway, this awful abomination works. Let's all move on to more
useful ways to spend our time...
2017-07-10 15:51:02 +10:00
Nyall Dawson
eb39fb0ebd Add SIP_VIRTUALERRORHANDLER to Doxyfile.in 2017-06-23 12:08:54 +10:00
Denis Rouzaud
9e176feeac gps fixes 2017-06-08 09:38:34 +02:00
Denis Rouzaud
fa5bd491fc run code_layout build from top CMakeLists
instead of adding an extra CMakeLists in .ci/travis/code_layout to build API doc, astyle and run tests (indentation, spelling, sip, doc coverage), the top CMakeLists has been adapted to allow not building core libraries and possibly just the static code layout
* astyle has been moved from /src/astyle to /lib/astyle (I would propose to move all external libraries, and possibly add git submodules)
2017-06-05 22:19:20 +02:00
Denis Rouzaud
281daee0ba run Doxygen and doc coverage test on static Travis config 2017-06-05 22:19:20 +02:00
Denis Rouzaud
98f653e6a5 sipify core raster part 2 2017-06-02 13:27:15 +02:00
Denis Rouzaud
f63adfe145 [sipify] keep external forward declaration 2017-05-24 15:39:46 +02:00
Denis Rouzaud
f5e66dd227 [sipify] handle constrained annotation 2017-05-24 14:49:28 +02:00
Denis Rouzaud
30a7e44d57 [sip] handle Deprecated annotations
some additional fixes in headers too
2017-05-24 09:49:46 +02:00
Denis Rouzaud
40972f06fa sipify batch 2017-05-18 21:34:21 +02:00
Denis Rouzaud
bfb62c4be9 [sipify] fix Abstract class
unblacklist qgstransaction.sip
(followup 931bf32a9fe46570ac80d947552d46c9f427457)
also fix method declaration with private only inheritance
2017-05-08 08:45:11 +02:00
Denis Rouzaud
6958db6f06 [sipify] rename SIP_PYARGTYPE to SIP_PYTYPE since it can be used to changed return types too 2017-05-03 07:22:30 +02:00
Denis Rouzaud
f0fb1f184a update Doxyfile to 1.8 template (#4428) 2017-04-28 10:00:14 +02:00
Denis Rouzaud
468fd97768 fix Doxygen build for new SIP macros 2017-04-27 13:13:20 +02:00
Denis Rouzaud
4cc4a27068 [sipify] operators, remove argument
* skip some operators
 * allow to remove an argument with SIP_PYARGREMOVE
2017-04-26 15:06:16 +02:00
Denis Rouzaud
448d2fddd3 [doxygen] add include path to allow macro retrieval 2017-04-25 13:28:01 +02:00
Matthias Kuhn
cfeab26bd8 [sipify] Add support for abstract classes 2017-04-07 12:26:30 +02:00
Matthias Kuhn
5da0318d21 Fix build warnings 2017-04-02 23:37:17 +02:00
Denis Rouzaud
f1d9d22a95 sipify: adds test to prepare-commit and adapt sipdiff
add missing macros to Doxyfile.in
2017-03-30 15:13:01 +02:00
Denis Rouzaud
15e4903890 sipify improvements
* add demo file and start a short doc
* fix some annotations
* do not display hidden line (SIP_SKIP, delete)
* use a defined var for SIP_SKIP
* remove constructor definition in header
* fix comment after method definition in header
* add a test for sipify itself
2017-03-30 15:13:01 +02:00
Matthias Kuhn
0bdaf4fc6d Ignore SIP annotations in doxygen 2017-03-30 15:13:01 +02:00
Denis Rouzaud
0a63d1f2c2 [spellcheck] properly look into various cases and add more fixes" 2017-01-16 16:39:20 +01:00
Denis Rouzaud
748be8de71 [spelling] replace behaviour by behavior 2017-01-11 11:35:19 +01:00
DelazJ
a56f928f71 Replace unicode by Unicode 2016-12-29 01:46:18 +01:00
Juergen E. Fischer
17090b9092 debian packaging update: add experimental build 2016-09-25 19:23:20 +02:00
Juergen E. Fischer
56a23e9f9a rebuild api documentation only when necessary 2016-09-21 23:43:30 +02:00
Nyall Dawson
9d59f9ce76 Generate QCH compiled help with qgis-api-doc package 2016-05-19 14:52:33 +10:00
Nyall Dawson
45f0cff256 Allow generation of Qt QHP help files from doxygen
This adds a new cmake option GENERATE_QHP. If the api docs are
set to being built (ie doxygen is available and WITH_APIDOC is true)
then setting GENERATE_QHP to true will cause doxygen to create
a compiled Qt help file from the QGIS docs.

This QHP file can then be used by QtCreator to show the QGIS
api directly within the QtCreator help (ie, press F1 on a class
or member to see the docs).

To do this, you need to:
- make sure doxygen is installed, WITH_APIDOC is true and
GENERATE_QHP is true
- build to generate the docs
- In QtCreator, go to Tools -> Options -> Help, switch to the
"Documentation" tab and click "Add". Point it to your generate
QHP file (should be in the build folder doc\api\qch folder)
- Restart QtCreator, wait a bit, and then you should have the
api docs available under the "Help" tab and by pressing F1
on a QGIS class/method
2016-05-19 13:55:11 +10:00
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