Source documentation/sv: Difference between revisions
Renatorivo (talk | contribs) (page) |
(Updating to match new version of source page) |
||
| Line 1: | Line 1: | ||
FreeCAD source is commented to allow automatic html documentation generation with [http://www.doxygen.org Doxygen]. |
|||
For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it! |
|||
För de som vill följa FreeCADs senaste svn versioner, och som vill ta en titt på c++ delen, så kan den första titten på källkoden ge intrycket av att du tittar på en igelkott: du kan inte se vad som är huvudet och svansen och vet inte hur du ska fånga den! |
|||
In complement to the Wiki, ''source documentation'' can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories. |
|||
I komplement till Wikin, så kan ''källkodsdokumentationen'' förhoppningsvis förminska detta intryck, genom att ge an ingångspunkt, och ger lättare sökning genom de många filerna och katalogerna. |
|||
==== |
==== Build source documentation ==== |
||
If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue |
|||
<syntaxhighlight> |
|||
make DevDoc |
make DevDoc |
||
</syntaxhighlight> |
|||
and consult the resulting html files starting from Doc/SourceDocu/html/index.html |
|||
(Notera: DevDoc målet är inte giltigt för autotools byggningar) |
|||
(note: the DevDoc target is not valid for autotools builds) |
|||
By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only). |
|||
Av sin natur så är källkodsdokumentationen, och kommer alltid att vara ett pågående arbete. Tveka inte att bygga om så ofta som nödvändigt. Om du hittar uppenbara oriktigheter, så känn dig fri att posta det på forumet (notera: det kontrolleras fullt endast med cMake byggprocessen). |
|||
As an alternative, the doc is generated from time to time and accessible on sourceforge [http://free-cad.sf.net/SrcDocu/index.html here] |
|||
==== |
==== Integrate Coin3D documentation ==== |
||
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. |
|||
It allows easier navigation and complete inheritance diagrams for Coin derived classes. |
|||
Det innebär lättare navigering och kompletta släktträd för Coin relaterade klasser. |
|||
* |
* On Debian and derived systems: |
||
: - |
: - Install the package libcoin60-doc |
||
: - |
: - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz |
||
: - Regenerate source documentation |
|||
: - Generera om källkodsdokumentationen |
|||
: |
: You are up for offline browsing. |
||
* |
* If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget). |
||
{{docnav |
{{docnav|Extra python modules|List of Commands}} |
||
| ⚫ | |||
{{languages/sv | {{en|Source documentation}} {{es|Source documentation/es}} {{fr|Source documentation/fr}} {{it|Source documentation/it}} {{ru|Source documentation/ru}} }} |
|||
{{clear}} |
|||
<languages/> |
|||
| ⚫ | |||
Revision as of 18:22, 22 September 2014
FreeCAD source is commented to allow automatic html documentation generation with Doxygen.
For those wanting to follow closely the latest svn versions of FreeCAD, and who try to have a look at the c++ part, the first insight in the sources can give the feeling you're looking at an hedgehog: you can't discriminate head from tail and don't really know how to catch it!
In complement to the Wiki, source documentation can hopefully alleviate this feeling, providing an entry point, and allowing for easy browsing through the dozens of files and directories.
Build source documentation
If you have Doxygen installed, it's very easy to build the doc. Go to your FreeCAD build directory, configure your sources with CMake, issue
make DevDocand consult the resulting html files starting from Doc/SourceDocu/html/index.html (note: the DevDoc target is not valid for autotools builds)
By nature, source doc is, and will ever be, work in progress. Don't hesitate to rebuild as often as needed. If you fall upon blatant inadequacies, feel free to post on the forum (note: It is really fully checked with cMake build process only).
As an alternative, the doc is generated from time to time and accessible on sourceforge here
Integrate Coin3D documentation
On unix systems, it is possible to link Coin3D source documentation with FreeCAD's. It allows easier navigation and complete inheritance diagrams for Coin derived classes.
- On Debian and derived systems:
- - Install the package libcoin60-doc
- - Uncompress the file /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- - Regenerate source documentation
- You are up for offline browsing.
- If you don't want to or can't install Coin doc package, the links will be generated to access coin doc online at doc.coin3D.org, if doxygen tag file can be downloaded at configure time (wget).
