diff -r d3c4d99860a9 -r 5f42cb5cc1bf doc-docbook/src/xml/osztaly-forma.xml --- a/doc-docbook/src/xml/osztaly-forma.xml Sat Apr 03 20:33:05 2004 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,219 +0,0 @@ - - - Osztály neve - - - - Ez a category rész nem kötelező. Ide kerülhet például, hogy ez egy - konténer-osztály, vagy gráf-osztály. - - - - A description egy kötelező rész. Egy általános leírás arról, hogy - mire jó ez az osztály, és hogyan kell használni. - - A description-be kerülhet új bekezdés is többek között. - - Egy link: - - - - Az example nem kötelező, de ajánlott rész. Ide kerülhet egy - konkrét leírás, ha szükséges, utána pedig a programkód, mondjuk a - programlisting elementbe ágyazva: - - -struct eqstr -{ - bool operator()(const char* s1, const char* s2) const - { - return strcmp(s1, s2) == 0; - } -}; - -void lookup(const map_type& Map, const char* str) -{ - -} - - - - A programlisting környezetben használhatóak különböző linkek, - viszont vigyázat, a programlisting mód parsolt, és minden - -t értelmez! - - - Az Emacs automata kiegészítő, element bezáró és element - felajánló képességei rendkívül fontosak ilyen xml fájlok - készítésénél, különben túl sokat kell gépelni. Egyelőre csak - olyan belül-nem-parsoló környezetet tudtam készíteni, ami az - xml-ben már nem szabványos, s az Emacs parsolója is kiakad - tőle. Így hát nincs olyan környezet, mint pl. a LaTeX - verbatim-ja. A kódokat egy CDATA blokkba kell beletenni, ami a - kövtekező képpen néz ki: <![CDATA[ ide jön a kód ]]> Az - eredetileg verbatim módnak szánt ]]> - element-nél szintén szükség van erre a CDATA blokkra, ha a - kódrész < vagy > karaktereket tartalmaz: - - - - my_edge_property(G); - for(EachEdgeIt i=G.first(); i.valid(); ++i) { - my_edge_property.set(i, _i); - _i*=_ii; ++_ii; - } - ]]> - - - - - A Definition rész kötelező, és ide kerül az, hogy mely fájlban van - definiálva az osztály. - - - - - - T - - - Ide kerül példának okáért a T paraméter leírása. - - - Ide kerülnek a feltételek az adott paraméterre. - - - A default értéket is fel kell tüntetni. - - - - - A - - - Az Af template paraméter azért került ide, - hogy látszódjon a táblázat. - - - Az Af-re vonatkozó feltételek. - - - 0 - - - - - - - - - Egy tag - - - Pl. vmelyik ősében. - - - Leírás, hogy mire való, miért van. - - - - - - Másik tag - - - Benne. - - - Leírás, hogy mire való, miért van. - - - - - - - - - Egy tag - - - Pl. vmelyik ősében. - - - Leírás, hogy mire való, miért van. - - - - - - Másik tag - - - Benne. - - - Leírás, hogy mire való, miért van. - - - - - - - - Egy tag - - - Pl. vmelyik ősében. - - - Leírás, hogy mire való, miért van. - - - - - - Másik tag - - - Benne. - - - Leírás, hogy mire való, miért van. - - - - - - - Megjegyzések: nem kötelező rész. A fenti 4 táblázat mind - opcionális. Ha nincsenek protected tagok, akkor az a táblázat - nyugodtan kimaradhat. A felhasználói doksiban pl. semmi szükség - az utolsó kettőre, de ez más kérdés. - - Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás. - - - - - - -