Source documentation

From FreeCAD Documentation
Revision as of 16:04, 7 December 2013 by Renatorivo (talk | contribs) (page)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

FreeCADs källkod är kommenterad för att tillåta automatisk generering av html dokumentation med Doxygen.

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!

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.

Bygga källkodsdokumentation

Om du har Doxygen installerat, så är det mycket enkelt att bygga dokumentationen. Gå till din FreeCAD byggkatalog, konfigurera din källkod med CMake, skriv

make DevDoc

och konsultera de resulterande html filerna med start i Doc/SourceDocu/html/index.html (Notera: DevDoc målet är inte giltigt för autotools byggningar)

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).

Som ett alternativ, så genereras dokumentationen då och då och finns här

Integrera Coin3D dokumentationen

På unix system, så är det möjligt att länka Coin3D's källk0dsdokumentation med FreeCAD's. Det innebär lättare navigering och kompletta släktträd för Coin relaterade klasser.

  • På Debian och relaterade system:
- Installera paketet libcoin60-doc
- Packa upp filen /usr/share/doc/libcoin60-doc/html/coin.tag.gz
- Generera om källkodsdokumentationen
Du är klar för offline läsning.
  • Om du inte vill eller inte kan installera Coin dokumentationspaketet, så kommer länkar att genereras för att komma åt coindokumentationen online på doc.coin3D.org, om doxygen tag filen kan laddas ned under konfigureringen (wget).
Available translations of this page: Flag-en.jpg Flag-es.jpg Flag-fr.jpg Flag-it.jpg Flag-ru.jpg