gravatar
alpar (Alpar Juttner)
alpar@cs.elte.hu
Doc improvements in LgfContents
0 1 0
default
1 file changed with 14 insertions and 11 deletions:
↑ Collapse diff ↑
Ignore white space 48 line context
... ...
@@ -2173,97 +2173,100 @@
2173 2173

	
2174 2174
    /// \brief Gives back the number of node sections in the file.
2175 2175
    ///
2176 2176
    /// Gives back the number of node sections in the file.
2177 2177
    int nodeSectionNum() const {
2178 2178
      return _node_sections.size();
2179 2179
    }
2180 2180

	
2181 2181
    /// \brief Returns the section name at the given position. 
2182 2182
    ///
2183 2183
    /// Returns the section name at the given position. 
2184 2184
    const std::string& nodeSection(int i) const {
2185 2185
      return _node_sections[i];
2186 2186
    }
2187 2187

	
2188 2188
    /// \brief Gives back the node maps for the given section.
2189 2189
    ///
2190 2190
    /// Gives back the node maps for the given section.
2191 2191
    const std::vector<std::string>& nodeMaps(int i) const {
2192 2192
      return _node_maps[i];
2193 2193
    }
2194 2194

	
2195 2195
    /// @}
2196 2196

	
2197
    /// \name Arc sections 
2197
    /// \name Arc/Edge sections 
2198 2198
    /// @{
2199 2199

	
2200
    /// \brief Gives back the number of arc sections in the file.
2200
    /// \brief Gives back the number of arc/edge sections in the file.
2201 2201
    ///
2202
    /// Gives back the number of arc sections in the file.
2203
    /// \note It is synonim of \c edgeSectionNum().
2202
    /// Gives back the number of arc/edge sections in the file.
2203
    /// \note It is synonym of \c edgeSectionNum().
2204 2204
    int arcSectionNum() const {
2205 2205
      return _edge_sections.size();
2206 2206
    }
2207 2207

	
2208 2208
    /// \brief Returns the section name at the given position. 
2209 2209
    ///
2210 2210
    /// Returns the section name at the given position. 
2211
    /// \note It is synonim of \c edgeSection().
2211
    /// \note It is synonym of \c edgeSection().
2212 2212
    const std::string& arcSection(int i) const {
2213 2213
      return _edge_sections[i];
2214 2214
    }
2215 2215

	
2216
    /// \brief Gives back the arc maps for the given section.
2216
    /// \brief Gives back the arc/edge maps for the given section.
2217 2217
    ///
2218
    /// Gives back the arc maps for the given section.
2219
    /// \note It is synonim of \c edgeMaps().
2218
    /// Gives back the arc/edge maps for the given section.
2219
    /// \note It is synonym of \c edgeMaps().
2220 2220
    const std::vector<std::string>& arcMaps(int i) const {
2221 2221
      return _edge_maps[i];
2222 2222
    }
2223 2223

	
2224 2224
    /// @}
2225 2225

	
2226
    /// \name Edge sections   
2226
    /// \name Synonyms
2227 2227
    /// @{
2228 2228

	
2229
    /// \brief Gives back the number of edge sections in the file.
2229
    /// \brief Gives back the number of arc/edge sections in the file.
2230 2230
    ///
2231
    /// Gives back the number of edge sections in the file.
2231
    /// Gives back the number of arc/edge sections in the file.
2232
    /// \note It is synonym of \c arcSectionNum().
2232 2233
    int edgeSectionNum() const {
2233 2234
      return _edge_sections.size();
2234 2235
    }
2235 2236

	
2236 2237
    /// \brief Returns the section name at the given position. 
2237 2238
    ///
2238 2239
    /// Returns the section name at the given position. 
2240
    /// \note It is synonym of \c arcSection().
2239 2241
    const std::string& edgeSection(int i) const {
2240 2242
      return _edge_sections[i];
2241 2243
    }
2242 2244

	
2243 2245
    /// \brief Gives back the edge maps for the given section.
2244 2246
    ///
2245 2247
    /// Gives back the edge maps for the given section.
2248
    /// \note It is synonym of \c arcMaps().
2246 2249
    const std::vector<std::string>& edgeMaps(int i) const {
2247 2250
      return _edge_maps[i];
2248 2251
    }
2249 2252

	
2250 2253
    /// @}
2251 2254

	
2252 2255
    /// \name Attribute sections   
2253 2256
    /// @{
2254 2257

	
2255 2258
    /// \brief Gives back the number of attribute sections in the file.
2256 2259
    ///
2257 2260
    /// Gives back the number of attribute sections in the file.
2258 2261
    int attributeSectionNum() const {
2259 2262
      return _attribute_sections.size();
2260 2263
    }
2261 2264

	
2262 2265
    /// \brief Returns the section name at the given position. 
2263 2266
    ///
2264 2267
    /// Returns the section name at the given position. 
2265 2268
    const std::string& attributeSection(int i) const {
2266 2269
      return _attribute_sections[i];
2267 2270
    }
2268 2271

	
2269 2272
    /// \brief Gives back the attributes for the given section.
0 comments (0 inline)