1 <etik:class id="haho" xreflabel="Példa osztály"> |
|
2 <etik:name> |
|
3 Osztály neve |
|
4 </etik:name> |
|
5 |
|
6 <etik:category> |
|
7 Ez a category rész nem kötelező. Ide kerülhet például, hogy ez egy |
|
8 konténer-osztály, vagy gráf-osztály. |
|
9 </etik:category> |
|
10 |
|
11 <etik:description> |
|
12 A description egy kötelező rész. Egy általános leírás arról, hogy |
|
13 mire jó ez az osztály, és hogyan kell használni. |
|
14 <para> |
|
15 A description-be kerülhet új bekezdés is többek között. |
|
16 </para> |
|
17 Egy link: <xref linkend="haho"/> |
|
18 </etik:description> |
|
19 |
|
20 <etik:example> |
|
21 Az example nem kötelező, de ajánlott rész. Ide kerülhet egy |
|
22 konkrét leírás, ha szükséges, utána pedig a programkód, mondjuk a |
|
23 programlisting elementbe ágyazva: |
|
24 <programlisting> |
|
25 |
|
26 struct eqstr |
|
27 { |
|
28 bool operator()(const char* s1, const char* s2) const |
|
29 { |
|
30 return strcmp(s1, s2) == 0; |
|
31 } |
|
32 }; |
|
33 |
|
34 void lookup(const map_type& Map, const char* str) |
|
35 { |
|
36 |
|
37 } |
|
38 |
|
39 </programlisting> |
|
40 |
|
41 A programlisting környezetben használhatóak különböző linkek, |
|
42 viszont vigyázat, a programlisting mód parsolt, és minden |
|
43 <![CDATA[<]]>-t értelmez! |
|
44 |
|
45 <para> |
|
46 Az Emacs automata kiegészítő, element bezáró és element |
|
47 felajánló képességei rendkívül fontosak ilyen xml fájlok |
|
48 készítésénél, különben túl sokat kell gépelni. Egyelőre csak |
|
49 olyan belül-nem-parsoló környezetet tudtam készíteni, ami az |
|
50 xml-ben már nem szabványos, s az Emacs parsolója is kiakad |
|
51 tőle. Így hát nincs olyan környezet, mint pl. a LaTeX |
|
52 verbatim-ja. A kódokat egy CDATA blokkba kell beletenni, ami a |
|
53 kövtekező képpen néz ki: <![CDATA[ ide jön a kód ]]> Az |
|
54 eredetileg verbatim módnak szánt <![CDATA[<etik:code>]]> |
|
55 element-nél szintén szükség van erre a CDATA blokkra, ha a |
|
56 kódrész < vagy > karaktereket tartalmaz: |
|
57 </para> |
|
58 |
|
59 <etik:code> |
|
60 <![CDATA[ |
|
61 int _i=1; |
|
62 int _ii=1; |
|
63 ListGraph::EdgeMap<int> my_edge_property(G); |
|
64 for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) { |
|
65 my_edge_property.set(i, _i); |
|
66 _i*=_ii; ++_ii; |
|
67 } |
|
68 ]]> |
|
69 </etik:code> |
|
70 </etik:example> |
|
71 |
|
72 <etik:definition> |
|
73 A Definition rész kötelező, és ide kerül az, hogy mely fájlban van |
|
74 definiálva az osztály. |
|
75 </etik:definition> |
|
76 |
|
77 <etik:template_params> |
|
78 <etik:template_param> |
|
79 <etik:templ_name> |
|
80 T |
|
81 </etik:templ_name> |
|
82 <etik:templ_description> |
|
83 Ide kerül példának okáért a T paraméter leírása. |
|
84 </etik:templ_description> |
|
85 <etik:templ_requirement> |
|
86 Ide kerülnek a feltételek az adott paraméterre. |
|
87 </etik:templ_requirement> |
|
88 <etik:templ_default> |
|
89 A default értéket is fel kell tüntetni. |
|
90 </etik:templ_default> |
|
91 </etik:template_param> |
|
92 <etik:template_param> |
|
93 <etik:templ_name> |
|
94 A |
|
95 </etik:templ_name> |
|
96 <etik:templ_description> |
|
97 Az Af template paraméter azért került ide, |
|
98 hogy látszódjon a táblázat. |
|
99 </etik:templ_description> |
|
100 <etik:templ_requirement> |
|
101 Az Af-re vonatkozó feltételek. |
|
102 </etik:templ_requirement> |
|
103 <etik:templ_default> |
|
104 0 |
|
105 </etik:templ_default> |
|
106 </etik:template_param> |
|
107 </etik:template_params> |
|
108 |
|
109 |
|
110 <etik:members> |
|
111 <etik:member> |
|
112 <etik:m_name> |
|
113 Egy tag |
|
114 </etik:m_name> |
|
115 <etik:m_where_def> |
|
116 Pl. vmelyik ősében. |
|
117 </etik:m_where_def> |
|
118 <etik:m_description> |
|
119 Leírás, hogy mire való, miért van. |
|
120 </etik:m_description> |
|
121 </etik:member> |
|
122 |
|
123 <etik:member> |
|
124 <etik:m_name> |
|
125 Másik tag |
|
126 </etik:m_name> |
|
127 <etik:m_where_def> |
|
128 Benne. |
|
129 </etik:m_where_def> |
|
130 <etik:m_description> |
|
131 Leírás, hogy mire való, miért van. |
|
132 </etik:m_description> |
|
133 </etik:member> |
|
134 </etik:members> |
|
135 |
|
136 |
|
137 <etik:prot_members> |
|
138 <etik:member> |
|
139 <etik:m_name> |
|
140 Egy tag |
|
141 </etik:m_name> |
|
142 <etik:m_where_def> |
|
143 Pl. vmelyik ősében. |
|
144 </etik:m_where_def> |
|
145 <etik:m_description> |
|
146 Leírás, hogy mire való, miért van. |
|
147 </etik:m_description> |
|
148 </etik:member> |
|
149 |
|
150 <etik:member> |
|
151 <etik:m_name> |
|
152 Másik tag |
|
153 </etik:m_name> |
|
154 <etik:m_where_def> |
|
155 Benne. |
|
156 </etik:m_where_def> |
|
157 <etik:m_description> |
|
158 Leírás, hogy mire való, miért van. |
|
159 </etik:m_description> |
|
160 </etik:member> |
|
161 </etik:prot_members> |
|
162 |
|
163 <etik:priv_members> |
|
164 <etik:member> |
|
165 <etik:m_name> |
|
166 Egy tag |
|
167 </etik:m_name> |
|
168 <etik:m_where_def> |
|
169 Pl. vmelyik ősében. |
|
170 </etik:m_where_def> |
|
171 <etik:m_description> |
|
172 Leírás, hogy mire való, miért van. |
|
173 </etik:m_description> |
|
174 </etik:member> |
|
175 |
|
176 <etik:member> |
|
177 <etik:m_name> |
|
178 Másik tag |
|
179 </etik:m_name> |
|
180 <etik:m_where_def> |
|
181 Benne. |
|
182 </etik:m_where_def> |
|
183 <etik:m_description> |
|
184 Leírás, hogy mire való, miért van. |
|
185 </etik:m_description> |
|
186 </etik:member> |
|
187 </etik:priv_members> |
|
188 |
|
189 |
|
190 <etik:notes> |
|
191 Megjegyzések: nem kötelező rész. A fenti 4 táblázat mind |
|
192 opcionális. Ha nincsenek protected tagok, akkor az a táblázat |
|
193 nyugodtan kimaradhat. A felhasználói doksiban pl. semmi szükség |
|
194 az utolsó kettőre, de ez más kérdés. |
|
195 <para> |
|
196 Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás. |
|
197 </para> |
|
198 </etik:notes> |
|
199 |
|
200 </etik:class> |
|
201 |
|
202 |
|
203 <!-- Keep this comment at the end of the file |
|
204 Local variables: |
|
205 mode: xml |
|
206 sgml-omittag:nil |
|
207 sgml-shorttag:nil |
|
208 sgml-namecase-general:nil |
|
209 sgml-general-insert-case:lower |
|
210 sgml-minimize-attributes:nil |
|
211 sgml-always-quote-attributes:t |
|
212 sgml-indent-step:2 |
|
213 sgml-indent-data:nil |
|
214 sgml-parent-document:("graph-classes.xml" "section" "etik:class") |
|
215 sgml-exposed-tags:nil |
|
216 sgml-local-catalogs:nil |
|
217 sgml-local-ecat-files:nil |
|
218 End: |
|
219 --> |
|