<etik:class id="haho" xreflabel="Példa osztály">

   <etik:name> 

     Osztály neve

   </etik:name>

   <etik:category>

     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.

   </etik:category>

   <etik:description>

     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.

     <para>

       A description-be kerülhet új bekezdés is többek között.

     </para>

     Egy link: <xref linkend="haho"/>

   </etik:description>

   <etik:example>

     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:

     <programlisting>

 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)

 {

 }

     </programlisting>

     A programlisting környezetben használhatóak különböző linkek,

     viszont vigyázat, a programlisting mód parsolt, és minden

     <![CDATA[<]]>-t értelmez!

       <para>

         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: &lt![CDATA[ ide jön a kód ]]&gt Az

         eredetileg verbatim módnak szánt <![CDATA[<etik:code>]]>

         element-nél szintén szükség van erre a CDATA blokkra, ha a

         kódrész &lt vagy &gt karaktereket tartalmaz:

       </para>

       <etik:code>

       <![CDATA[

 int _i=1;

 int _ii=1;

 ListGraph::EdgeMap<int> my_edge_property(G);

  for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {

    my_edge_property.set(i, _i);

    _i*=_ii; ++_ii;

  }

     ]]>

     </etik:code>

   </etik:example>

   <etik:definition>

     A Definition rész kötelező, és ide kerül az, hogy mely fájlban van

     definiálva az osztály.

   </etik:definition>

   <etik:template_params>

     <etik:template_param>

       <etik:templ_name>

         T

       </etik:templ_name>

       <etik:templ_description>

         Ide kerül példának okáért a T paraméter leírása.

       </etik:templ_description>

       <etik:templ_requirement>

         Ide kerülnek a feltételek az adott paraméterre. 

       </etik:templ_requirement>

       <etik:templ_default>

         A default értéket is fel kell tüntetni.

       </etik:templ_default>

     </etik:template_param>

     <etik:template_param>

       <etik:templ_name>

         A

       </etik:templ_name>

       <etik:templ_description>

         Az Af template paraméter azért került ide, 

         hogy látszódjon a táblázat.

       </etik:templ_description>

       <etik:templ_requirement>

         Az Af-re vonatkozó feltételek.

       </etik:templ_requirement>

       <etik:templ_default>

         0

       </etik:templ_default>

     </etik:template_param>

   </etik:template_params>

   <etik:members>

     <etik:member>

       <etik:m_name>

         Egy tag

       </etik:m_name>

       <etik:m_where_def>

         Pl. vmelyik ősében.

       </etik:m_where_def>

       <etik:m_description>

         Leírás, hogy mire való, miért van.

       </etik:m_description>

     </etik:member>

     <etik:member>

       <etik:m_name>

         Másik tag

       </etik:m_name>

       <etik:m_where_def>

         Benne.

       </etik:m_where_def>

       <etik:m_description>

         Leírás, hogy mire való, miért van.

       </etik:m_description>

     </etik:member>

   </etik:members>

   <etik:prot_members>

     <etik:member>

       <etik:m_name>

         Egy tag

       </etik:m_name>

       <etik:m_where_def>

         Pl. vmelyik ősében.

       </etik:m_where_def>

       <etik:m_description>

         Leírás, hogy mire való, miért van.

       </etik:m_description>

     </etik:member>

     <etik:member>

       <etik:m_name>

         Másik tag

       </etik:m_name>

       <etik:m_where_def>

         Benne.

       </etik:m_where_def>

       <etik:m_description>

         Leírás, hogy mire való, miért van.

       </etik:m_description>

     </etik:member>

   </etik:prot_members>

   <etik:priv_members>

     <etik:member>

       <etik:m_name>

         Egy tag

       </etik:m_name>

       <etik:m_where_def>

         Pl. vmelyik ősében.

       </etik:m_where_def>

       <etik:m_description>

         Leírás, hogy mire való, miért van.

       </etik:m_description>

     </etik:member>

     <etik:member>

       <etik:m_name>

         Másik tag

       </etik:m_name>

       <etik:m_where_def>

         Benne.

       </etik:m_where_def>

       <etik:m_description>

         Leírás, hogy mire való, miért van.

       </etik:m_description>

     </etik:member>

   </etik:priv_members>

   <etik:notes>

     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.

     <para>

       Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás.

     </para>

   </etik:notes>

 </etik:class>

 <!-- Keep this comment at the end of the file

 Local variables:

 mode: xml

 sgml-omittag:nil

 sgml-shorttag:nil

 sgml-namecase-general:nil

 sgml-general-insert-case:lower

 sgml-minimize-attributes:nil

 sgml-always-quote-attributes:t

 sgml-indent-step:2

 sgml-indent-data:nil

 sgml-parent-document:("graph-classes.xml" "section" "etik:class")

 sgml-exposed-tags:nil

 sgml-local-catalogs:nil

 sgml-local-ecat-files:nil

 End:

 -->