diff -r c0e556186c55 -r 37407947454f doc-docbook/src/xml/osztaly-forma.xml --- a/doc-docbook/src/xml/osztaly-forma.xml Thu Mar 04 12:59:24 2004 +0000 +++ b/doc-docbook/src/xml/osztaly-forma.xml Thu Mar 04 13:01:53 2004 +0000 @@ -1,23 +1,27 @@ - - - Osztaly neve - + + + Osztály neve + - - Ez itt egy tobbsoros, tobb reszes leiras arrol, hogy altalanossagban - mire is jo ez az osztaly. Ez itt egy tobbsoros, tobb reszes leiras - arrol, hogy altalanossagban mire is jo ez az osztaly. - - Ez itt az uj bekezdese a leirasnak, mert elofordulhat, hogy tobb - bekezdesre erdemes tagolni az iromanyt. - - + + 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. + + + - - Gyakran hasznos egy peldan bemutatni a mukodest. A kovetkezo egy - egyszeru kis szemleltetes arra, hogy ezt milyen konnyen es gyorsan - lehet hasznalni: - + + 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 { @@ -32,90 +36,166 @@ } - + -Vigyázat, a programlisting mód parsolt, és minden -t értelmez! -Előnye, hogy lehet bele linkeket csinálni, de talán kényelmesebb egy LaTeX-szerű -verbatim-mód, ezt valósítja meg az ]]> element. + A programlisting környezetben használhatóak különböző linkek, + viszont vigyázat, a programlisting mód parsolt, és minden + -t értelmez! - - int _i=1; - int _ii=1; - ListGraph::EdgeMap my_edge_property(G); - for(EachEdgeIt i=G.first(); i.valid(); ++i) { - my_edge_property.set(i, _i); - _i*=_ii; ++_ii; - } - - + + 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: + - -Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban -van definialva az aktualis osztaly. -Ez egy link a tutorialra. - + + my_edge_property(G); + for(EachEdgeIt i=G.first(); i.valid(); ++i) { + my_edge_property.set(i, _i); + _i*=_ii; ++_ii; + } + ]]> + + - - - -T - - -Ez itt a T parameter. Ebben adod meg hogy milyen izekbol epitsunk kupacot. - - -Legyen implementalva neki az osszehasonlito operator. - - -Az nincs - - - - -Af - - -Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell. - - -Af szarmazzon az elemi osztalyokbol. - - -0 - - - + + 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 + + + - - - -iterator - - -container - - -Arra valo, hogy vegigiteraljunk vele. - - - - -void push_back(const T&) - - -Back Insertion Sequence - - -Egy uj element tesz e vegere. - + + + + 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. + + @@ -131,7 +211,7 @@ sgml-always-quote-attributes:t sgml-indent-step:2 sgml-indent-data:nil -sgml-parent-document:("graph-classes.xml" "sect1" "etik:class") +sgml-parent-document:("graph-classes.xml" "section" "etik:class") sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil