|
Introducing |
||
This document describes the structure of the UDK.
In general the documentation contains tutorials, specifications,
concepts, component specific documentation and generated
reference documentation. There are several different sub directories. The directories "c", "cpp" and "java" contain language specific documentation. The directory "common" contains language independent documents. The directory "man" contains manually written documentation. Under
this directory there may exist "images", "tutorial", "spec",
"component" and "concept" directories. This will help to organize
the documents. The directory "ref" contains generated documentation. The following tree is the current one (10/10/00) of the UDK documentation: udk/www/common/man/images/ concept/ ref/ cpp/man/images/ tutorial/ spec/ ref/cppu/ cppuhelper/ registry/ sal/ stor/ vos/ java/man/images ref/ There exist another project which is very important to the UDK documentation.
This is the API project. There are
all interfaces specified and documented. There are often bidirectional
links between UDK and API. So I'll explain the structure of the API
documentation too. api/www/common/ref/ api/www/common/ref/com/ api/www/common/ref/com/sun/ api/www/common/ref/com/sun/star/ api/www/common/ref/com/sun/star/... If you need a link between projects please use absolute names (e.g. "http://api.openoffice.org"). |
||
|
||
Auhor: Markus Meyer ($Date: 2001/08/09 13:11:22 $) |
||
|