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