mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-17 00:04:02 -04:00
update CODING, regenerate t2t, include CODING.html
This commit is contained in:
parent
5a2beb36e8
commit
6b1bc026f9
1
.gitignore
vendored
1
.gitignore
vendored
@ -35,7 +35,6 @@ scripts/astyle.exe
|
|||||||
*.out
|
*.out
|
||||||
*.tex
|
*.tex
|
||||||
*.toc
|
*.toc
|
||||||
doc/CODING.html
|
|
||||||
doc/CODING.tex
|
doc/CODING.tex
|
||||||
doc/INSTALL.tex
|
doc/INSTALL.tex
|
||||||
scripts/Debug
|
scripts/Debug
|
||||||
|
106
CODING
106
CODING
@ -20,7 +20,7 @@ Developers guide for QGIS
|
|||||||
1.3.3. Keyword Substitution
|
1.3.3. Keyword Substitution
|
||||||
1.4. Variable Names
|
1.4. Variable Names
|
||||||
1.5. Enumerated Types
|
1.5. Enumerated Types
|
||||||
1.6. Global Constants
|
1.6. Global Constants & Macros
|
||||||
1.7. Editing
|
1.7. Editing
|
||||||
1.7.1. Tabs
|
1.7.1. Tabs
|
||||||
1.7.2. Indentation
|
1.7.2. Indentation
|
||||||
@ -30,9 +30,8 @@ Developers guide for QGIS
|
|||||||
1.9.1. Where-ever Possible Generalize Code
|
1.9.1. Where-ever Possible Generalize Code
|
||||||
1.9.2. Prefer Having Constants First in Predicates
|
1.9.2. Prefer Having Constants First in Predicates
|
||||||
1.9.3. Whitespace Can Be Your Friend
|
1.9.3. Whitespace Can Be Your Friend
|
||||||
1.9.4. Add Trailing Identifying Comments
|
1.9.4. Use Braces Even for Single Line Statements
|
||||||
1.9.5. Use Braces Even for Single Line Statements
|
1.9.5. Book recommendations
|
||||||
1.9.6. Book recommendations
|
|
||||||
2. GIT Access
|
2. GIT Access
|
||||||
2.1. Installation
|
2.1. Installation
|
||||||
2.1.1. Install git for GNU/Linux
|
2.1.1. Install git for GNU/Linux
|
||||||
@ -225,16 +224,16 @@ Enumerated types should be named in CamelCase with a leading capital e.g.:
|
|||||||
Feet,
|
Feet,
|
||||||
Degrees,
|
Degrees,
|
||||||
UnknownUnit
|
UnknownUnit
|
||||||
} ;
|
};
|
||||||
|
|
||||||
Do not use generic type names that will conflict with other types. e.g. use
|
Do not use generic type names that will conflict with other types. e.g. use
|
||||||
"UnkownUnit" rather than "Unknown"
|
"UnkownUnit" rather than "Unknown"
|
||||||
|
|
||||||
|
|
||||||
1.6. Global Constants
|
1.6. Global Constants & Macros
|
||||||
=====================
|
==============================
|
||||||
|
|
||||||
Global constants should be written in upper case underscore separated e.g.:
|
Global constants and macros should be written in upper case underscore separated e.g.:
|
||||||
|
|
||||||
const long GEOCRS_ID = 3344;
|
const long GEOCRS_ID = 3344;
|
||||||
|
|
||||||
@ -252,14 +251,21 @@ requirements are met.
|
|||||||
Set your editor to emulate tabs with spaces. Tab spacing should be set to 2
|
Set your editor to emulate tabs with spaces. Tab spacing should be set to 2
|
||||||
spaces.
|
spaces.
|
||||||
|
|
||||||
|
Note: In vim this is done with set expandtab ts=2
|
||||||
|
|
||||||
|
|
||||||
1.7.2. Indentation
|
1.7.2. Indentation
|
||||||
==================
|
==================
|
||||||
|
|
||||||
Source code should be indented to improve readability. There is a .indent.pro
|
Source code should be indented to improve readability. There is a
|
||||||
file in the QGIS src directory that contains the switches to be used when
|
scripts/prepare-commit.sh that looks up the changed files and reindents them
|
||||||
indenting code using the GNU indent program. If you don't use GNU indent, you
|
using astyle. This should be run before committing. You can also use
|
||||||
should emulate these settings.
|
scripts/astyle.sh to indent individual files.
|
||||||
|
|
||||||
|
As newer versions of astyle indent differently than the version used to do a
|
||||||
|
complete reindentation of the source, the script uses an old astyle version,
|
||||||
|
that we include in our repository (enable WITH_ASTYLE in cmake to include it in
|
||||||
|
the build).
|
||||||
|
|
||||||
|
|
||||||
1.7.3. Braces
|
1.7.3. Braces
|
||||||
@ -277,37 +283,40 @@ Braces should start on the line following the expression:
|
|||||||
...
|
...
|
||||||
}
|
}
|
||||||
|
|
||||||
There is a scripts/prepare-commit.sh that looks up the changed files and
|
|
||||||
reindents them using astyle. This should be run before committing.
|
|
||||||
|
|
||||||
As newer versions of astyle indent differently than the version used to do a
|
|
||||||
complete reindentation of the source, the script uses an old astyle version,
|
|
||||||
that we include in our repository.
|
|
||||||
|
|
||||||
|
|
||||||
1.8. API Compatibility
|
1.8. API Compatibility
|
||||||
======================
|
======================
|
||||||
|
|
||||||
From QGIS 1.0 we will provide a stable, backwards compatible API. This will
|
We try to keep the API stable and backwards compatible. Cleanups to the API
|
||||||
provide a stable basis for people to develop against, knowing their code will
|
should be done in a manner similar to the Trolltech developers e.g.
|
||||||
work against any of the 1.x QGIS releases (although recompiling may be
|
|
||||||
required).Cleanups to the API should be done in a manner similar to the
|
|
||||||
Trolltech developers e.g.
|
|
||||||
|
|
||||||
class Foo
|
class Foo
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
/** This method will be deprecated, you are encouraged to use
|
/** This method will be deprecated, you are encouraged to use
|
||||||
doSomethingBetter() rather.
|
doSomethingBetter() rather.
|
||||||
@see doSomethingBetter()
|
@deprecated doSomethingBetter()
|
||||||
*/
|
*/
|
||||||
bool doSomething();
|
Q_DECL_DEPRECATED bool doSomething();
|
||||||
|
|
||||||
/** Does something a better way.
|
/** Does something a better way.
|
||||||
@note This method was introduced in QGIS version 1.1
|
@note added in 1.1
|
||||||
*/
|
*/
|
||||||
bool doSomethingBetter();
|
bool doSomethingBetter();
|
||||||
|
|
||||||
|
signal:
|
||||||
|
/** This signal will be deprecated, you are encouraged to
|
||||||
|
connect to somethingHappenedBetter() rather.
|
||||||
|
@deprecated use somethingHappenedBetter()
|
||||||
|
*/
|
||||||
|
#ifndef Q_MOC_RUN
|
||||||
|
Q_DECL_DEPRECATED
|
||||||
|
#endif
|
||||||
|
bool somethingHappened();
|
||||||
|
|
||||||
|
/** Something happened
|
||||||
|
@note added in 1.1
|
||||||
|
bool somethingHappenedBetter();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
@ -359,29 +368,10 @@ or this:
|
|||||||
|
|
||||||
if ( ! a && b )
|
if ( ! a && b )
|
||||||
|
|
||||||
|
Note: prepare-commit.sh will take care of this.
|
||||||
1.9.4. Add Trailing Identifying Comments
|
|
||||||
========================================
|
|
||||||
|
|
||||||
Adding comments at the end of function, struct and class implementations makes
|
|
||||||
it easier to find them later.
|
|
||||||
|
|
||||||
Consider that you're at the bottom of a source file and need to find a very
|
|
||||||
long function -- without these kinds of trailing comments you will have to page
|
|
||||||
up past the body of the function to find its name. Of course this is ok if you
|
|
||||||
wanted to find the beginning of the function; but what if you were interested
|
|
||||||
at code near its end? You'd have to page up and then back down again to the
|
|
||||||
desired part.
|
|
||||||
|
|
||||||
e.g.,
|
|
||||||
|
|
||||||
void foo::bar()
|
|
||||||
{
|
|
||||||
// ... imagine a lot of code here
|
|
||||||
} // foo::bar()
|
|
||||||
|
|
||||||
|
|
||||||
1.9.5. Use Braces Even for Single Line Statements
|
1.9.4. Use Braces Even for Single Line Statements
|
||||||
=================================================
|
=================================================
|
||||||
|
|
||||||
Using braces for code in if/then blocks or similar code structures even for
|
Using braces for code in if/then blocks or similar code structures even for
|
||||||
@ -392,7 +382,7 @@ Consider:
|
|||||||
|
|
||||||
if (foo)
|
if (foo)
|
||||||
bar();
|
bar();
|
||||||
else
|
else
|
||||||
baz();
|
baz();
|
||||||
|
|
||||||
Adding code after bar() or baz() without adding enclosing braces would create
|
Adding code after bar() or baz() without adding enclosing braces would create
|
||||||
@ -407,11 +397,11 @@ So, prefer this:
|
|||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
baz();
|
baz();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
1.9.6. Book recommendations
|
1.9.5. Book recommendations
|
||||||
===========================
|
===========================
|
||||||
|
|
||||||
- Effective C++ (http://www.awprofessional.com/title/0321334876), Scott Meyers
|
- Effective C++ (http://www.awprofessional.com/title/0321334876), Scott Meyers
|
||||||
@ -444,7 +434,7 @@ Debian based distro users can do:
|
|||||||
2.1.2. Install git for Windows
|
2.1.2. Install git for Windows
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
Windows users can obtain msys git (http://code.google.com/p/msysgit/).
|
Windows users can obtain msys git (http://code.google.com/p/msysgit/) or use git distributed with cygwin (http://cygwin.com).
|
||||||
|
|
||||||
|
|
||||||
2.1.3. Install git for OSX
|
2.1.3. Install git for OSX
|
||||||
@ -1448,7 +1438,7 @@ guidelines are followed in layout and design of GUIs.
|
|||||||
boxes with only a single widget / item inside.
|
boxes with only a single widget / item inside.
|
||||||
2. Capitalise first letter only in labels:
|
2. Capitalise first letter only in labels:
|
||||||
Labels (and group box labels) should be written as a phrase with leading
|
Labels (and group box labels) should be written as a phrase with leading
|
||||||
capital letter, and all remaing words written with lower case first letters
|
capital letter, and all remaining words written with lower case first letters
|
||||||
3. Do not end labels for widgets or group boxes with a colon:
|
3. Do not end labels for widgets or group boxes with a colon:
|
||||||
Adding a colon causes visual noise and does not impart additional meaning,
|
Adding a colon causes visual noise and does not impart additional meaning,
|
||||||
so don't use them. An exception to this rule is when you have two labels next
|
so don't use them. An exception to this rule is when you have two labels next
|
||||||
@ -1491,13 +1481,3 @@ guidelines are followed in layout and design of GUIs.
|
|||||||
- Gary Sherman
|
- Gary Sherman
|
||||||
- Marco Hugentobler
|
- Marco Hugentobler
|
||||||
|
|
||||||
Original pages from wiki to deprecate:
|
|
||||||
|
|
||||||
- http://wiki.qgis.org/qgiswiki/CodingGuidelines (./)
|
|
||||||
- http://wiki.qgis.org/qgiswiki/CodingStandards (./)
|
|
||||||
- http://wiki.qgis.org/qgiswiki/UsingSubversion (./)
|
|
||||||
- http://www.qgis.org/wiki/How_to_debug_QGIS_Plugins
|
|
||||||
- http://wiki.qgis.org/qgiswiki/DevelopmentInBranches (./)
|
|
||||||
- http://wiki.qgis.org/qgiswiki/SubmittingPatchesAndSvnAccess (./)
|
|
||||||
|
|
||||||
|
|
||||||
|
21
INSTALL
21
INSTALL
@ -1,10 +1,10 @@
|
|||||||
QGIS
|
QGIS
|
||||||
Building QGIS from source - step by step
|
Building QGIS from source - step by step
|
||||||
Saturday November 30, 2013
|
Saturday January 25, 2014
|
||||||
|
|
||||||
|
|
||||||
Last Updated: Saturday November 30, 2013
|
Last Updated: Saturday January 25, 2014
|
||||||
Last Change : Saturday November 30, 2013
|
Last Change : Thursday November 21, 2013
|
||||||
|
|
||||||
|
|
||||||
1. Introduction
|
1. Introduction
|
||||||
@ -167,14 +167,13 @@ Now update your local sources database:
|
|||||||
===============================
|
===============================
|
||||||
|
|
||||||
|| Distribution | install command for packages |
|
|| Distribution | install command for packages |
|
||||||
| lucid | ``apt-get install bison cmake doxygen flex git-core graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| precise | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb`` |
|
||||||
| maverick | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| quantal | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb`` |
|
||||||
| natty | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| raring | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libpython2.7-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb`` |
|
||||||
| oneiric | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| saucy | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libpython2.7-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb`` |
|
||||||
| precise | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| wheezy | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb`` |
|
||||||
| sid | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| jessie | ``apt-get install bison cmake flex grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev`` |
|
||||||
| squeeze | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
| sid | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python-all python-all-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb`` |
|
||||||
| wheezy | ``apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb`` |
|
|
||||||
|
|
||||||
(extracted from the respective control files in debian/)
|
(extracted from the respective control files in debian/)
|
||||||
|
|
||||||
|
1916
doc/CODING.html
Normal file
1916
doc/CODING.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -209,15 +209,15 @@ Enumerated types should be named in CamelCase with a leading capital e.g.:
|
|||||||
Feet,
|
Feet,
|
||||||
Degrees,
|
Degrees,
|
||||||
UnknownUnit
|
UnknownUnit
|
||||||
} ;
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
Do not use generic type names that will conflict with other types. e.g. use
|
Do not use generic type names that will conflict with other types. e.g. use
|
||||||
"UnkownUnit" rather than "Unknown"
|
"UnkownUnit" rather than "Unknown"
|
||||||
|
|
||||||
== Global Constants ==
|
== Global Constants & Macros ==
|
||||||
|
|
||||||
Global constants should be written in upper case underscore separated e.g.:
|
Global constants and macros should be written in upper case underscore separated e.g.:
|
||||||
|
|
||||||
```
|
```
|
||||||
const long GEOCRS_ID = 3344;
|
const long GEOCRS_ID = 3344;
|
||||||
@ -231,11 +231,19 @@ requirements are met.
|
|||||||
Set your editor to emulate tabs with spaces. Tab spacing should be set to 2
|
Set your editor to emulate tabs with spaces. Tab spacing should be set to 2
|
||||||
spaces.
|
spaces.
|
||||||
|
|
||||||
|
**Note:** In vim this is done with set expandtab ts=2
|
||||||
|
|
||||||
=== Indentation ===
|
=== Indentation ===
|
||||||
Source code should be indented to improve readability. There is a .indent.pro
|
|
||||||
file in the QGIS src directory that contains the switches to be used when
|
Source code should be indented to improve readability. There is a
|
||||||
indenting code using the GNU indent program. If you don't use GNU indent, you
|
scripts/prepare-commit.sh that looks up the changed files and reindents them
|
||||||
should emulate these settings.
|
using astyle. This should be run before committing. You can also use
|
||||||
|
``scripts/astyle.sh`` to indent individual files.
|
||||||
|
|
||||||
|
As newer versions of astyle indent differently than the version used to do a
|
||||||
|
complete reindentation of the source, the script uses an old astyle version,
|
||||||
|
that we include in our repository (enable WITH_ASTYLE in cmake to include it in
|
||||||
|
the build).
|
||||||
|
|
||||||
=== Braces ===
|
=== Braces ===
|
||||||
Braces should start on the line following the expression:
|
Braces should start on the line following the expression:
|
||||||
@ -251,20 +259,10 @@ Braces should start on the line following the expression:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
There is a scripts/prepare-commit.sh that looks up the changed files and
|
|
||||||
reindents them using astyle. This should be run before committing.
|
|
||||||
|
|
||||||
As newer versions of astyle indent differently than the version used to do a
|
|
||||||
complete reindentation of the source, the script uses an old astyle version,
|
|
||||||
that we include in our repository.
|
|
||||||
|
|
||||||
== API Compatibility ==
|
== API Compatibility ==
|
||||||
|
|
||||||
From QGIS 1.0 we will provide a stable, backwards compatible API. This will
|
We try to keep the API stable and backwards compatible. Cleanups to the API
|
||||||
provide a stable basis for people to develop against, knowing their code will
|
should be done in a manner similar to the Trolltech developers e.g.
|
||||||
work against any of the 1.x QGIS releases (although recompiling may be
|
|
||||||
required).Cleanups to the API should be done in a manner similar to the
|
|
||||||
Trolltech developers e.g.
|
|
||||||
|
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -273,15 +271,28 @@ class Foo
|
|||||||
public:
|
public:
|
||||||
/** This method will be deprecated, you are encouraged to use
|
/** This method will be deprecated, you are encouraged to use
|
||||||
doSomethingBetter() rather.
|
doSomethingBetter() rather.
|
||||||
@see doSomethingBetter()
|
@deprecated doSomethingBetter()
|
||||||
*/
|
*/
|
||||||
bool doSomething();
|
Q_DECL_DEPRECATED bool doSomething();
|
||||||
|
|
||||||
/** Does something a better way.
|
/** Does something a better way.
|
||||||
@note This method was introduced in QGIS version 1.1
|
@note added in 1.1
|
||||||
*/
|
*/
|
||||||
bool doSomethingBetter();
|
bool doSomethingBetter();
|
||||||
|
|
||||||
|
signal:
|
||||||
|
/** This signal will be deprecated, you are encouraged to
|
||||||
|
connect to somethingHappenedBetter() rather.
|
||||||
|
@deprecated use somethingHappenedBetter()
|
||||||
|
*/
|
||||||
|
#ifndef Q_MOC_RUN
|
||||||
|
Q_DECL_DEPRECATED
|
||||||
|
#endif
|
||||||
|
bool somethingHappened();
|
||||||
|
|
||||||
|
/** Something happened
|
||||||
|
@note added in 1.1
|
||||||
|
bool somethingHappenedBetter();
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -335,28 +346,7 @@ or this:
|
|||||||
if ( ! a && b )
|
if ( ! a && b )
|
||||||
```
|
```
|
||||||
|
|
||||||
=== Add Trailing Identifying Comments ===
|
**Note:** prepare-commit.sh will take care of this.
|
||||||
|
|
||||||
Adding comments at the end of function, struct and class implementations makes
|
|
||||||
it easier to find them later.
|
|
||||||
|
|
||||||
|
|
||||||
Consider that you're at the bottom of a source file and need to find a very
|
|
||||||
long function -- without these kinds of trailing comments you will have to page
|
|
||||||
up past the body of the function to find its name. Of course this is ok if you
|
|
||||||
wanted to find the beginning of the function; but what if you were interested
|
|
||||||
at code near its end? You'd have to page up and then back down again to the
|
|
||||||
desired part.
|
|
||||||
|
|
||||||
e.g.,
|
|
||||||
|
|
||||||
```
|
|
||||||
void foo::bar()
|
|
||||||
{
|
|
||||||
// ... imagine a lot of code here
|
|
||||||
} // foo::bar()
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
=== Use Braces Even for Single Line Statements ===
|
=== Use Braces Even for Single Line Statements ===
|
||||||
|
|
||||||
@ -370,7 +360,7 @@ Consider:
|
|||||||
```
|
```
|
||||||
if (foo)
|
if (foo)
|
||||||
bar();
|
bar();
|
||||||
else
|
else
|
||||||
baz();
|
baz();
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -387,7 +377,7 @@ So, prefer this:
|
|||||||
}
|
}
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
baz();
|
baz();
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -421,7 +411,7 @@ sudo apt-get install git
|
|||||||
|
|
||||||
=== Install git for Windows ===
|
=== Install git for Windows ===
|
||||||
|
|
||||||
Windows users can obtain [msys git http://code.google.com/p/msysgit/].
|
Windows users can obtain [msys git http://code.google.com/p/msysgit/] or use git distributed with [cygwin http://cygwin.com].
|
||||||
|
|
||||||
=== Install git for OSX ===
|
=== Install git for OSX ===
|
||||||
|
|
||||||
@ -679,8 +669,6 @@ submit patches which are unencumbered by conflicting intellectual property
|
|||||||
rights. Also do not submit code that you are not happy to have made available
|
rights. Also do not submit code that you are not happy to have made available
|
||||||
under the GPL.
|
under the GPL.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
== Obtaining GIT Write Access ==
|
== Obtaining GIT Write Access ==
|
||||||
|
|
||||||
Write access to QGIS source tree is by invitation. Typically when a person
|
Write access to QGIS source tree is by invitation. Typically when a person
|
||||||
@ -1506,12 +1494,3 @@ guidelines are followed in layout and design of GUIs.
|
|||||||
- Marco Hugentobler
|
- Marco Hugentobler
|
||||||
-
|
-
|
||||||
|
|
||||||
Original pages from wiki to deprecate:
|
|
||||||
|
|
||||||
- http://wiki.qgis.org/qgiswiki/CodingGuidelines (./)
|
|
||||||
- http://wiki.qgis.org/qgiswiki/CodingStandards (./)
|
|
||||||
- http://wiki.qgis.org/qgiswiki/UsingSubversion (./)
|
|
||||||
- http://www.qgis.org/wiki/How_to_debug_QGIS_Plugins
|
|
||||||
- http://wiki.qgis.org/qgiswiki/DevelopmentInBranches (./)
|
|
||||||
- http://wiki.qgis.org/qgiswiki/SubmittingPatchesAndSvnAccess (./)
|
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@
|
|||||||
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
|
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
|
||||||
<TITLE>QGIS</TITLE>
|
<TITLE>QGIS</TITLE>
|
||||||
|
|
||||||
<!-- Included /home/fischer/src/qgis/qgis/doc/style.css -->
|
<!-- Included /home/fischer/src/qgis/doc/style.css -->
|
||||||
<STYLE TYPE="text/css">
|
<STYLE TYPE="text/css">
|
||||||
body{ background: white;
|
body{ background: white;
|
||||||
color: black;
|
color: black;
|
||||||
@ -77,13 +77,13 @@ label{ background-color: #FFFFCC;
|
|||||||
<DIV CLASS="header" ID="header">
|
<DIV CLASS="header" ID="header">
|
||||||
<H1>QGIS</H1>
|
<H1>QGIS</H1>
|
||||||
<H2>Building QGIS from source - step by step</H2>
|
<H2>Building QGIS from source - step by step</H2>
|
||||||
<H3>Saturday November 30, 2013</H3>
|
<H3>Saturday January 25, 2014</H3>
|
||||||
</DIV>
|
</DIV>
|
||||||
|
|
||||||
<DIV CLASS="body" ID="body">
|
<DIV CLASS="body" ID="body">
|
||||||
<P>
|
<P>
|
||||||
Last Updated: Saturday November 30, 2013
|
Last Updated: Saturday January 25, 2014
|
||||||
Last Change : Saturday November 30, 2013
|
Last Change : Thursday November 21, 2013
|
||||||
</P>
|
</P>
|
||||||
<DIV CLASS="toc">
|
<DIV CLASS="toc">
|
||||||
|
|
||||||
@ -293,36 +293,32 @@ sudo apt-get update
|
|||||||
<TH>install command for packages</TH>
|
<TH>install command for packages</TH>
|
||||||
</TR>
|
</TR>
|
||||||
<TR>
|
<TR>
|
||||||
<TD>lucid</TD>
|
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git-core graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
|
||||||
</TR>
|
|
||||||
<TR>
|
|
||||||
<TD>maverick</TD>
|
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
|
||||||
</TR>
|
|
||||||
<TR>
|
|
||||||
<TD>natty</TD>
|
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
|
||||||
</TR>
|
|
||||||
<TR>
|
|
||||||
<TD>oneiric</TD>
|
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
|
||||||
</TR>
|
|
||||||
<TR>
|
|
||||||
<TD>precise</TD>
|
<TD>precise</TD>
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb</CODE></TD>
|
||||||
</TR>
|
</TR>
|
||||||
<TR>
|
<TR>
|
||||||
<TD>sid</TD>
|
<TD>quantal</TD>
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb</CODE></TD>
|
||||||
</TR>
|
</TR>
|
||||||
<TR>
|
<TR>
|
||||||
<TD>squeeze</TD>
|
<TD>raring</TD>
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libpython2.7-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb</CODE></TD>
|
||||||
|
</TR>
|
||||||
|
<TR>
|
||||||
|
<TD>saucy</TD>
|
||||||
|
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libpython2.7-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt5-qt4-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb</CODE></TD>
|
||||||
</TR>
|
</TR>
|
||||||
<TR>
|
<TR>
|
||||||
<TD>wheezy</TD>
|
<TD>wheezy</TD>
|
||||||
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-base xvfb</CODE></TD>
|
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb</CODE></TD>
|
||||||
|
</TR>
|
||||||
|
<TR>
|
||||||
|
<TD>jessie</TD>
|
||||||
|
<TD><CODE>apt-get install bison cmake flex grass-dev libexpat1-dev libfcgi-dev libgdal1-dev libgeos-dev libgsl0-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python python-dev python-qt4 python-qt4-dev python-sip python-sip-dev</CODE></TD>
|
||||||
|
</TR>
|
||||||
|
<TR>
|
||||||
|
<TD>sid</TD>
|
||||||
|
<TD><CODE>apt-get install bison cmake doxygen flex git graphviz grass-dev libexpat1-dev libfcgi-dev libgdal-dev libgeos-dev libgsl0-dev libopenscenegraph-dev libosgearth-dev libpq-dev libproj-dev libqt4-dev libqt4-opengl-dev libqtwebkit-dev libqwt-dev libspatialindex-dev libspatialite-dev libsqlite3-dev pkg-config pyqt4-dev-tools python-all python-all-dev python-qt4 python-qt4-dev python-sip python-sip-dev txt2tags xauth xfonts-100dpi xfonts-75dpi xfonts-base xfonts-scalable xvfb</CODE></TD>
|
||||||
</TR>
|
</TR>
|
||||||
</TABLE>
|
</TABLE>
|
||||||
|
|
||||||
@ -3227,5 +3223,5 @@ The following people have contributed to this document:
|
|||||||
|
|
||||||
</DIV>
|
</DIV>
|
||||||
<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
|
<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
|
||||||
<!-- cmdline: txt2tags -o/home/fischer/src/qgis/qgis/debian/build/doc/INSTALL.html -t html /home/fischer/src/qgis/qgis/doc/INSTALL.t2t -->
|
<!-- cmdline: txt2tags -o/home/fischer/src/qgis/debian/build/doc/INSTALL.html -t html /home/fischer/src/qgis/doc/INSTALL.t2t -->
|
||||||
</BODY></HTML>
|
</BODY></HTML>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user