45f0cff256
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
About QGIS
QGIS is an Open Source Geographic Information System. The project was born in May of 2002 and was established as a project on SourceForge in June of the same year. We've worked hard to make GIS software (which is traditionally expensive commercial software) a viable prospect for anyone with basic access to a Personal Computer. QGIS currently runs on most Unix platforms, Windows, and OS X. QGIS is developed using the Qt toolkit (http://qt.io) and C++. This means that QGIS feels snappy to use and has a pleasing, easy to use graphical user interface.
QGIS aims to be an easy to use GIS, providing common functions and features. The initial goal was to provide a GIS data viewer. QGIS has reached that point in its evolution and is being used by many for their daily GIS data viewing and editing needs. QGIS supports a number of raster and vector data formats, with new support easily added using the plugin architecture.
QGIS is released under the GNU Public License (GPL) Version 2 or above. Developing QGIS under this license means that you can (if you want to) inspect and modify the source code and guarantees that you, our happy user will always have access to a GIS program that is free of cost and can be freely modified.
Supported raster formats include:
- Grass
- USGS DEM
- ArcInfo binary grid
- ArcInfo ASCII grid
- ERDAS Imagine
- SDTS
- GeoTiff
- Tiff with world file
- WMS, WCS
Supported vector formats include:
- ESRI Shapefiles
- PostgreSQL/PostGIS
- GRASS
- Spatialite
- Other OGR supported formats
- MSSQL
- Oracle
- WFS
Note
Please follow the installation instructions carefully. After extracting the distribution, you can find the HTML version of the installation document in qgis/doc/index.html. The installation document is also available as PDF in the same directory.
Help us
Please submit bug reports using the QGIS bug tracker. When reporting a bug, either login or, if you don't have a qgis trac, provide an email address where we can request additional information.
Support
You can get support in the following ways:
- Using the QGIS community site at http://qgis.org
- Joining the qgis-users mailing list
- Using IRC by joining the #qgis channel on irc.freenode.net. Please wait around for a response to your question as many folks on the channel are doing other things and it may take a while for them to notice your question.
- Join the Gitter chat.
Contribute
QGIS is on GitHub at https://github.com/qgis/QGIS. If you wish to contribute patches you can fork the project, make your changes, commit to your repository, and then issue a pull request. The development team can then review your contribution and commit it upstream as appropriate. If you commit a new feature, add [FEATURE] to your commit message AND give a clear description of the new feature. A webhook will automatically create an issue on the QGIS-Documentation repo to tell people to write about it.
If you are not a developer, there are many other possibilities which do not require programing skills to help QGIS to evolve. Check our project homepage for more information.