B ˛EC - Baza Pi˛eknych Czarownic Podr˛ecznik

BEC
˛ - Baza Pi˛eknych Czarownic Podr˛ecznik
0.0.1-beta
Wygenerowano przez Doxygen 1.4.6
Sun Jun 17 15:18:24 2007
Spis treści
1
2
3
4
5
6
BEC
˛ - Baza Pi˛eknych Czarownic
1
1.1
Ogólna charakterystyka . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
1.2
Przykład dołaczania
˛
obrazka . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1
1.3
Uwagi końcowe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2
BEC
˛ - Baza Pi˛eknych Czarownic Indeks hierarchiczny
3
2.1
3
BEC
˛ - Baza Pi˛eknych Czarownic Hierarchia klas . . . . . . . . . . . . . . . . . . . . . .
BEC
˛ - Baza Pi˛eknych Czarownic Indeks klas
5
3.1
5
BEC
˛ - Baza Pi˛eknych Czarownic Lista klas . . . . . . . . . . . . . . . . . . . . . . . . .
BEC
˛ - Baza Pi˛eknych Czarownic Indeks plików
7
4.1
7
BEC
˛ - Baza Pi˛eknych Czarownic Lista plików . . . . . . . . . . . . . . . . . . . . . . . .
BEC
˛ - Baza Pi˛eknych Czarownic Dokumentacja klas
9
5.1
Dokumentacja klasy ListaPieknychCzarownic . . . . . . . . . . . . . . . . . . . . . . . .
9
5.2
Dokumentacja klasy PieknaCzarownica . . . . . . . . . . . . . . . . . . . . . . . . . . .
10
BEC
˛ - Baza Pi˛eknych Czarownic Dokumentacja plików
13
6.1
Dokumentacja pliku listapieknychczarownic.hh . . . . . . . . . . . . . . . . . . . . . . .
13
6.2
Dokumentacja pliku pieknaczarownica.hh . . . . . . . . . . . . . . . . . . . . . . . . . .
14
Rozdział 1
BEC
˛ - Baza Pi˛eknych Czarownic
1.1
Ogólna charakterystyka
Niniejszy plik zawiera przykład realizacji strony głównej i podziału jej na odpowiednie sekcje. W dalszej
cz˛eści znajduje si˛e przykład dołaczania
˛
rysunków.
1.2
Przykład dołaczania
˛
obrazka
W tej sekcji poniżej znajduje si˛e przykład dołaczania
˛
obrazka
Rysunek 1.1: Przykład dołaczanego
˛
zrzutu okienka aplikacji
2
1.3
BEC
˛ - Baza Pi˛eknych Czarownic
Uwagi końcowe
W przygotowaniu jest Baza Brzydkich Czarodzieji (w skócie: BBC).
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
Rozdział 2
BEC
˛ - Baza Pi˛eknych Czarownic
Indeks hierarchiczny
2.1
BEC
˛ - Baza Pi˛eknych Czarownic Hierarchia klas
Ta lista dziedziczenia posortowana jest z grubsza, choć nie całkowicie, alfabetycznie:
ListaPieknychCzarownic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PieknaCzarownica . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
9
10
4
BEC
˛ - Baza Pi˛eknych Czarownic Indeks hierarchiczny
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
Rozdział 3
BEC
˛ - Baza Pi˛eknych Czarownic
Indeks klas
3.1
BEC
˛ - Baza Pi˛eknych Czarownic Lista klas
Tutaj znajduja˛ si˛e klasy, struktury, unie i interfejsy wraz z ich krótkimi opisami:
ListaPieknychCzarownic (Modeluje list˛e pi˛eknych czarownic ) . . . . . . . . . . . . . . . . . .
PieknaCzarownica (Modeluje pi˛ekna˛ czarownic˛e ) . . . . . . . . . . . . . . . . . . . . . . . . .
9
10
6
BEC
˛ - Baza Pi˛eknych Czarownic Indeks klas
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
Rozdział 4
BEC
˛ - Baza Pi˛eknych Czarownic
Indeks plików
4.1
BEC
˛ - Baza Pi˛eknych Czarownic Lista plików
Tutaj znajduje si˛e lista wszystkich udokumentowanych plików z ich krótkimi opisami:
listapieknychczarownic.hh (Zawiera definicj˛e klasy ListaPieknychCzarownic ) . . . . . . . . . .
pieknaczarownica.hh (Zawiera definicj˛e klasy PieknaCzarownica ) . . . . . . . . . . . . . . . .
13
14
8
BEC
˛ - Baza Pi˛eknych Czarownic Indeks plików
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
Rozdział 5
BEC
˛ - Baza Pi˛eknych Czarownic
Dokumentacja klas
5.1
Dokumentacja klasy ListaPieknychCzarownic
Modeluje list˛e pi˛eknych czarownic.
#include <listapieknychczarownic.hh>
5.1.1
Opis szczegółowy
Klasa modeluje list˛e pi˛eknych czarownic. Kryterium przynależności do klasy jest subiektywne. Ponadto
przyjmuje si˛e, że każda czarodziejka jest z definicji pi˛ekna˛ czarownica.˛
Struktura listy jest zorganizowana w oparciu standardowy szablon list.
Dokumentacja dla tej klasy została wygenerowana z pliku:
• listapieknychczarownic.hh
10
BEC
˛ - Baza Pi˛eknych Czarownic Dokumentacja klas
5.2
Dokumentacja klasy PieknaCzarownica
Modeluje pi˛ekna˛ czarownic˛e.
#include <pieknaczarownica.hh>
Metody publiczne
• unsigned int WezIloscKul () const
Udost˛epnia ilość kul.
• void ZmienIloscKul (unsigned int Ilosc)
Zmienia ilość kul.
Atrybuty prywatne
• unsigned int _IloscCzarnychKotow
Ilość czarnych kotów.
• unsigned int _IloscKul
Ilość szklanych kul.
• std::string _MarkaMiotlyWyscigowej
Marka i oznaczenie miotły wyścigowej.
5.2.1
Opis szczegółowy
Klasa modeluje prawdziwa˛ pi˛ekna˛ czarownic˛e. Atrybutami klasy sa˛ dane dotyczace
˛ ekwipunku pi˛eknej
czarownicy tj. szklana kula, czarne koty, miotła wyścigowa (patrz opis poszczególnych pól, np. _IloscCzarnychKotow)
Kryterium przynależności do klasy jest subiektywne. Ponadto przyjmuje si˛e, że każda czarodziejka jest z
definicji pi˛ekna˛ czarownica.˛
5.2.2
Dokumentacja funkcji składowych
5.2.2.1
unsigned int PieknaCzarownica::WezIloscKul () const
Udost˛epnia ilość kul. Jest ona wartościa˛ przechowywana˛ w polu _IloscKul.
5.2.2.2
void PieknaCzarownica::ZmienIloscKul (unsigned int Ilosc)
Wpisuje nowa˛ wartość ilości kul, jaka˛ posiada pi˛ekna czarownica.
Parametry:
Ilosc - nowa wartość ilości kul.
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
5.2 Dokumentacja klasy PieknaCzarownica
11
Warunek wst˛epny:
Wartość parametru Ilosc musi być zawsze wi˛eksza od 0.
Warunek końcowy:
Wartość parametru Ilosc zostaje przypisana polu _IloscKul.
5.2.3
Dokumentacja atrybutów składowych
5.2.3.1
unsigned int PieknaCzarownica::_IloscCzarnychKotow [private]
Pole zawiera liczb˛e czarnych kotów jakie posiada pi˛ekna czarownica. Dopuszcza si˛e, że ilość może być
równa 0.
5.2.3.2
unsigned int PieknaCzarownica::_IloscKul [private]
Pole zawiera liczb˛e szklanych kul. Zakłada si˛e, że ilość musi być zawsze wi˛eksza od 0.
5.2.3.3
std::string PieknaCzarownica::_MarkaMiotlyWyscigowej [private]
Pole zawiera mark˛e i oznaczenie miotły wyścigowej. Nazwa pusta oznacza brak miotły.
Dokumentacja dla tej klasy została wygenerowana z pliku:
• pieknaczarownica.hh
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
12
BEC
˛ - Baza Pi˛eknych Czarownic Dokumentacja klas
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
Rozdział 6
BEC
˛ - Baza Pi˛eknych Czarownic
Dokumentacja plików
6.1
Dokumentacja pliku listapieknychczarownic.hh
Zawiera definicj˛e klasy ListaPieknychCzarownic.
#include "pieknaczarownica.hh"
Wykres zależności załaczania
˛
dla listapieknychczarownic.hh:
Komponenty
• class ListaPieknychCzarownic
Modeluje list˛e pi˛eknych czarownic.
6.1.1
Opis szczegółowy
Plik zawiera definicj˛e klasy ListaPieknychCzarownic. Klasa ta wyprowadzona jest z klasy lista.
Autor:
Jan Gandalf
Data:
2003.12.01
Wersja:
1.0.0
14
BEC
˛ - Baza Pi˛eknych Czarownic Dokumentacja plików
6.2
Dokumentacja pliku pieknaczarownica.hh
Zawiera definicj˛e klasy PieknaCzarownica.
Ten wykres pokazuje, które pliki bezpośrednio lub pośrednio załaczaj
˛
a˛ ten plik:
Komponenty
• class PieknaCzarownica
Modeluje pi˛ekna˛ czarownic˛e.
6.2.1
Opis szczegółowy
Plik zawiera definicj˛e klasy PieknaCzarownica. Obiekty tej klasy sa˛ składnikami listy modelowanej przez
klas˛e ListaPieknychCzarownic.
Autor:
Jan Gandalf
Data:
2003.12.01
Wersja:
1.0.0
Wygenerowano Sun Jun 17 15:18:24 2007 dla BEC
˛ - Baza Pi˛eknych Czarownic programem Doxygen
Skorowidz
_IloscCzarnychKotow
PieknaCzarownica, 11
_IloscKul
PieknaCzarownica, 11
_MarkaMiotlyWyscigowej
PieknaCzarownica, 11
ListaPieknychCzarownic, 9
listapieknychczarownic.hh, 13
PieknaCzarownica, 10
PieknaCzarownica
_IloscCzarnychKotow, 11
_IloscKul, 11
_MarkaMiotlyWyscigowej, 11
WezIloscKul, 10
ZmienIloscKul, 10
pieknaczarownica.hh, 14
WezIloscKul
PieknaCzarownica, 10
ZmienIloscKul
PieknaCzarownica, 10