immibis
/
colobot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:adiblol/colobot

dev-ui
Programerus 2012-04-16 23:31:27 +02:00
parent 0c2073a80b 6d6faaa19d
commit 658226a6f7
3 changed files with 165 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
# Ignore the documentation folder
/doc

43
Doxyfile
View File

@ -52,7 +52,7 @@ PROJECT_LOGO =
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = "C:/Documents and Settings/Piotrek/Pulpit/colobot/doc"
OUTPUT_DIRECTORY = "./doc"
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
# 4096 sub-directories (in 2 levels) under the output directory of each output
@ -671,7 +671,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = "C:/Documents and Settings/Piotrek/Pulpit/colobot/src"
INPUT = "src" "src/CBot"
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@ -689,38 +689,9 @@ INPUT_ENCODING = UTF-8
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
# *.f90 *.f *.for *.vhd *.vhdl
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
FILE_PATTERNS = *.h \
*.cpp \
*.c++ \
*.d \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.idl \
*.odl \
*.cs \
*.php \
*.php3 \
*.inc \
*.m \
*.mm \
*.dox \
*.py \
*.f90 \
*.f \
*.for \
*.vhd \
*.vhdl
*.doc.txt
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
@ -1681,7 +1652,7 @@ CLASS_GRAPH = YES
# indirect implementation dependencies (inheritance, containment, and
# class references variables) of the class with other documented classes.
COLLABORATION_GRAPH = YES
COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
# will generate a graph for groups, showing the direct groups dependencies
@ -1720,7 +1691,7 @@ INCLUDE_GRAPH = YES
# documented header file showing the documented files that directly or
# indirectly include this file.
INCLUDED_BY_GRAPH = YES
INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH and HAVE_DOT options are set to YES then
# doxygen will generate a call dependency graph for every global function
@ -1728,7 +1699,7 @@ INCLUDED_BY_GRAPH = YES
# the time of a run. So in most cases it will be better to enable call graphs
# for selected functions only using the \callgraph command.
CALL_GRAPH = YES
CALL_GRAPH = NO
# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
# doxygen will generate a caller dependency graph for every global function

156
src/docmain.doc.txt Normal file
View File

@ -0,0 +1,156 @@
This file is part of code documentation. Do not remove it.
/**
\mainpage
Doxygen documentation of Colobot project
\section Intro Introduction
The source code released by Epitec was sparsely documented. This documentation, written from scratch,
will aim to describe the various components of the code.
Currently, it contains only the automatically generated content from Doxygen
and the following brief description of source code files.
\section Files Short description of source files
(Currently in Polish, translation coming soon...)
Lista modułów <b>.cpp</b>:
- <b>auto.cpp</b> - Główna klasa odpowiadająca za obsługę stacjonarnych elementów. Posiada klasy dziedziczące:
- <b>autobase.cpp</b> - Klasa odpowiadająca za obsługę statku kosmicznego.
- <b>autoconverter.cpp</b> - Klasa odpowiadająca za obsługę huty tytanu.
- <b>autoderrick.cpp</b> - Klasa odpowiadająca za obsługę kopalni.
- <b>autodestroyer.cpp</b> - ?
- <b>autoegg.cpp</b> - Klasa odpowiadająca za obsługę jaj obcych.
- <b>autoenergy.cpp</b> - Klasa odpowiadająca za obsługę fabryki ogniw elektrycznych.
- <b>autofactory.cpp</b> - Klasa odpowiadająca za obsługę fabryki robotów.
- <b>autoflag.cpp</b> - Klasa odpowiadająca za obsługę flagi.
- <b>autohuston.cpp</b> - Klasa odpowiadająca za obsługę Centrum Kontroli Misji w Houston.
- <b>autoinfo.cpp</b> - Klasa odpowiadająca za obsługę stacji przekaźnikowej.
- <b>autojostle.cpp</b> - ?
- <b>autokid.cpp</b> - ?
- <b>autolabo.cpp</b> - Klasa odpowiadająca za obsługę laboratorium.
- <b>automush.cpp</b> - Klasa odpowiadająca za obsługę grzybów.
- <b>autonest.cpp</b> - Klasa odpowiadająca za obsługę gniazda obcych.
- <b>autonuclear.cpp</b> - Klasa odpowiadająca za obsługę reaktora jądrowego.
- <b>autopara.cpp</b> - Klasa odpowiadająca za obsługę odgromnika.
- <b>autoportico.cpp</b> - Klasa odpowiadająca za obsługę drzwi statku kosmicznego.
- <b>autoradar.cpp</b> - Klasa odpowiadająca za obsługę radaru.
- <b>autorepair.cpp</b> - Klasa odpowiadająca za obsługę warsztatu.
- <b>autoresearch.cpp</b> - Klasa odpowiadająca za obsługę centrum badawczego.
- <b>autoroot.cpp</b> - Klasa odpowiadająca za obsługę korzeni.
- <b>autosafe.cpp</b> - Klasa odpowiadająca za obsługę skrytki.
- <b>autostation.cpp</b> - Klasa odpowiadająca za obsługę elektrowni.
- <b>autotower.cpp</b> - Klasa odpowiadająca za obsługę wieży obronnej.
- <b>blitz.cpp</b> - Klasa odpowiadająca za obsługę piorunów.
- <b>brain.cpp</b> - Klasa odpowiadająca za obsługę programów i poleceń dla robotów i budynków.
- <b>camera.cpp</b> - Klasa odpowiadająca za obsługę kamery.
- <b>cbottoken.cpp</b> - Funkcje odpowiadające za zwracanie informacji do „Podręcznika programowania”.
- <b>ClassFILE.cpp</b> - Funkcje odpowiadające za obsługę plików w CBOT.
- <b>cloud.cpp</b> - Klasa odpowiadająca za obsługę chmur.
- <b>cmdtoken.cpp</b> - Funkcje odpowiadające za obsługę typów w CBOT.
- <b>control.cpp</b> - Główna klasa odpowiadająca za obsługę kontrolek. Posiada klasy dziedziczące:
- <b>button.cpp</b> - Klasa odpowiadająca za obsługę przycisków.
- <b>check.cpp</b> - Klasa odpowiadająca za obsługę przycisków zaznaczania.
- <b>color.cpp</b> - Klasa odpowiadająca za obsługę jednokolorowych elementów.
- <b>compass.cpp</b> - Klasa odpowiadająca za obsługę kompasu.
- <b>edit.cpp</b> - Klasa odpowiadająca za obsługę edytora programów.
- <b>editvalue.cpp</b> - Klasa odpowiadająca za obsługę zaznaczeń.
- <b>gauge.cpp</b> - Klasa odpowiadająca za obsługę wskaźników.
- <b>group.cpp</b> - Klasa odpowiadająca za obsługę tła ikon.
- <b>image.cpp</b> - Klasa odpowiadająca za obsługę obrazków.
- <b>key.cpp</b> - Klasa odpowiadająca za obsługę klawiszy.
- <b>label.cpp</b> - Klasa odpowiadająca za obsługę etykiet.
- <b>list.cpp</b> - Klasa odpowiadająca za obsługę list.
- <b>map.cpp</b> - Klasa odpowiadająca za obsługę mapy.
- <b>scroll.cpp</b> - Klasa odpowiadająca za obsługę przycisków do przewijania.
- <b>shortcut.cpp</b> - Klasa odpowiadająca za obsługę skrótów.
- <b>slider.cpp</b> - Klasa odpowiadająca za obsługę paska przewijania.
- <b>target.cpp</b> - Klasa odpowiadająca za obsługę znaczników celu.
- <b>window.cpp</b> - Klasa odpowiadająca za obsługę okna.
- <b>d3dapp.cpp</b> - Klasa odpowiadająca za uruchomienie programu. Zawiera funkcję WinMain().
- <b>d3dengine.cpp</b> - Klasa zawierająca silnik gry.
- <b>d3denum.cpp</b> - Funkcje odpowiadające za typy wyliczeniowe D3D.
- <b>d3dframe.cpp</b> - Klasa odpowiadająca za zaimplementowanie struktur D3D.
- <b>d3dmath.cpp</b> - Funkcje matematyczne D3D.
- <b>d3dtextr.cpp</b> - Funkcje odpowiadające za zarządzanie teksturami.
- <b>d3dutil.cpp</b> - Funkcje odpowiadające za używanie obiektów DirectX.
- <b>dd.cpp</b> - Funkcje kompilujące funkcję „space()” CBOTa.
- <b>displayinfo.cpp</b> - Klasa odpowiadająca za wyświetlanie informacji w SatCom.
- <b>displaytext.cpp</b> - Klasa odpowiadająca za wyświetlanie informacji.
- <b>event.cpp</b> - Klasa odpowiadająca za obsługę zdarzeń.
- <b>iman.cpp</b> - Menedżer instancji.
- <b>interface.cpp</b> - Klasa odpowiadająca za tworzenie kontrolek.
- <b>joystick.cpp</b> - Obsługa DirectInput.
- <b>light.cpp</b> - Klasa odpowiadająca za obsługę światła.
- <b>maindialog.cpp</b> - Klasa odpowiadająca za obsługę menu.
- <b>mainmap.cpp</b> - Klasa odpowiadająca za obsługę mini mapy.
- <b>mainmovie.cpp</b> - Klasa odpowiadająca za obsługę filmików.
- <b>mainshort.cpp</b> - Klasa odpowiadająca za obsługę skrótów.
- <b>math3d.cpp</b> - Funkcje matematyczne.
- <b>metafile.cpp</b> - Klasa odpowiadająca za obsługę plików ‘.dat’.
- <b>misc.cpp</b> - Funkcje przetwarzające znaki.
- <b>model.cpp</b> - Klasa odpowiadająca za obsługę modeli.
- <b>modfile.cpp</b> - Klasa odpowiadająca za obsługę plików modeli.
- <b>motion.cpp</b> - Główna klasa odpowiadająca za obsługę ruchomych modeli. Posiada klasy dziedziczące:
- <b>motionant.cpp</b> - Klasa odpowiadająca za ruch mrówki.
- <b>motionbee.cpp</b> - Klasa odpowiadająca za ruch osy.
- <b>motionhuman.cpp</b> - Klasa odpowiadająca za ruch człowieka.
- <b>motionmother.cpp</b> - Klasa odpowiadająca za ruch Królowej Obcych.
- <b>motionspider.cpp</b> - Klasa odpowiadająca za ruch pająka.
- <b>motiontoto.cpp</b> - Klasa odpowiadająca za ruch „toto”.
- <b>motionvehicle.cpp</b> - Klasa odpowiadająca za ruch robotów.
- <b>motionworm.cpp</b> - Klasa odpowiadająca za ruch robaka.
- <b>object.cpp</b> - Klasa odpowiadająca za obsługę obiektów.
- <b>particule.cpp</b> - Klasa odpowiadająca za obsługę cząsteczek.
- <b>physics.cpp</b> - Klasa odpowiadająca za obsługę zdarzeń fizycznych.
- <b>planet.cpp</b> - Klasa odpowiadająca za obsługę planet.
- <b>profile.cpp</b> - Funkcje przetwarzające profile.
- <b>pyro.cpp</b> - Klasa odpowiadająca za obsługę efektów pirotechnicznych.
- <b>restext.cpp</b> - Baza tekstów.
- <b>robotmain.cpp</b> - Klasa odpowiadająca za obsługę robotów.
- <b>script.cpp</b> - Klasa odpowiadająca za obsługę funkcji CBOT.
- <b>sound.cpp</b> - Klasa odpowiadająca za obsługę dźwięku.
- <b>studio.cpp</b> - Klasa odpowiadająca za obsługę edytora CBOT.
- <b>task.cpp</b> - Główna klasa odpowiadająca za obsługę zadań dla robotów i budynków. Posiada klasy dziedziczące:
- <b>taskadvance.cpp</b> - Klasa odpowiadająca za obsługę poruszania się w przód/tył.
- <b>taskbuild.cpp</b> - Klasa odpowiadająca za obsługę budowania.
- <b>taskfire.cpp</b> - Klasa odpowiadająca za obsługę strzelania.
- <b>taskfireant.cpp</b> - Klasa odpowiadająca za obsługę strzelania przez mrówkę.
- <b>taskflag.cpp</b> - Klasa odpowiadająca za obsługę flagi.
- <b>taskgoto.cpp</b> - Klasa odpowiadająca za obsługę polecenia „goto()”.
- <b>taskgungoal.cpp</b> - ?
- <b>taskinfo.cpp</b> - Klasa odpowiadająca za obsługę stacji przekaźnikowej.
- <b>taskmanip.cpp</b> - Klasa odpowiadająca za obsługę ramienia robota.
- <b>taskpen.cpp</b> - Klasa odpowiadająca za obsługę kredek.
- <b>taskrecover.cpp</b> - Klasa odpowiadająca za obsługę odzyskiwania tytanu.
- <b>taskreset.cpp</b> - ?
- <b>tasksearch.cpp</b> - Klasa odpowiadająca za obsługę przeszukiwania podłoża.
- <b>taskshield.cpp</b> - Klasa odpowiadająca za obsługę pola ochronnego.
- <b>taskspiderexplo.cpp</b> - Klasa odpowiadająca za obsługę wybuchu pająka.
- <b>tasktake.cpp</b> - Klasa odpowiadająca za obsługę chwytaka.
- <b>taskterraform.cpp</b> - Klasa odpowiadająca za obsługę uderzacza.
- <b>taskturn.cpp</b> - Klasa odpowiadająca za obsługę obracania się.
- <b>taskwait.cpp</b> - Klasa odpowiadająca za obsługę czekania.
- <b>taskmanager.cpp</b> - Klasa odpowiadająca za zarządzanie zadaniami dla robotów i budynków.
- <b>terrain.cpp</b> - Klasa odpowiadająca za nakładanie tekstur na mapę.
- <b>text.cpp</b> - Klasa odpowiadająca za wyświetlanie tekstu.
- <b>water.cpp</b> - Klasa odpowiadająca za obsługę wody.
Ważniejsze pliki <b>.h</b>:
- <b>event.h</b> - typ wyliczeniowy EventMsg.
- <b>global.h</b> - stałe dla budynków i badań.
- <b>language.h</b> - wybór trybu kompilacji.
- <b>misc.h</b> - typy wyliczeniowe ClassType i Error, stałe dla klawiszy.
*/