gravatar
alpar (Alpar Juttner)
alpar@cs.elte.hu
Fix several doxygen warnings
0 3 0
default
3 files changed with 30 insertions and 30 deletions:
↑ Collapse diff ↑
Ignore white space 6 line context
... ...
@@ -524,28 +524,28 @@
524 524
	  b.bottom_left.y = std::max(this->bottom_left.y,u.bottom_left.y);
525 525
	  b.top_right.x = std::min(this->top_right.x,u.top_right.x);
526 526
	  b.top_right.y = std::min(this->top_right.y,u.top_right.y);
527 527
	  b._empty = b.bottom_left.x > b.top_right.x ||
528 528
	             b.bottom_left.y > b.top_right.y;
529 529
	} 
530 530
        return b;
531 531
      }
532 532

	
533 533
    };//class Boundingbox
534 534

	
535 535

	
536
  ///Map of x-coordinates of a \ref Point "Point"-map
536
  ///Map of x-coordinates of a Point map
537 537

	
538 538
  ///\ingroup maps
539
  ///Map of x-coordinates of a \ref Point "Point"-map.
539
  ///Map of x-coordinates of a \ref dim2::Point "Point"-map.
540 540
  ///
541 541
  template<class M>
542 542
  class XMap 
543 543
  {
544 544
    M& _map;
545 545
  public:
546 546

	
547 547
    typedef typename M::Value::Value Value;
548 548
    typedef typename M::Key Key;
549 549
    ///\e
550 550
    XMap(M& map) : _map(map) {}
551 551
    Value operator[](Key k) const {return _map[k].x;}
... ...
@@ -561,25 +561,25 @@
561 561
  template<class M> 
562 562
  inline XMap<M> xMap(M &m) 
563 563
  {
564 564
    return XMap<M>(m);
565 565
  }
566 566

	
567 567
  template<class M> 
568 568
  inline XMap<M> xMap(const M &m) 
569 569
  {
570 570
    return XMap<M>(m);
571 571
  }
572 572

	
573
  ///Constant (read only) version of \ref XMap
573
  ///Constant (read only) version of XMap
574 574

	
575 575
  ///\ingroup maps
576 576
  ///Constant (read only) version of \ref XMap
577 577
  ///
578 578
  template<class M>
579 579
  class ConstXMap 
580 580
  {
581 581
    const M& _map;
582 582
  public:
583 583

	
584 584
    typedef typename M::Value::Value Value;
585 585
    typedef typename M::Key Key;
... ...
@@ -591,25 +591,25 @@
591 591
  ///Returns a \ref ConstXMap class
592 592

	
593 593
  ///This function just returns a \ref ConstXMap class.
594 594
  ///
595 595
  ///\ingroup maps
596 596
  ///\relates ConstXMap
597 597
  template<class M> 
598 598
  inline ConstXMap<M> xMap(const M &m) 
599 599
  {
600 600
    return ConstXMap<M>(m);
601 601
  }
602 602

	
603
  ///Map of y-coordinates of a \ref Point "Point"-map
603
  ///Map of y-coordinates of a Point map
604 604
    
605 605
  ///\ingroup maps
606 606
  ///Map of y-coordinates of a \ref Point "Point"-map.
607 607
  ///
608 608
  template<class M>
609 609
  class YMap 
610 610
  {
611 611
    M& _map;
612 612
  public:
613 613

	
614 614
    typedef typename M::Value::Value Value;
615 615
    typedef typename M::Key Key;
... ...
@@ -628,25 +628,25 @@
628 628
  template<class M> 
629 629
  inline YMap<M> yMap(M &m) 
630 630
  {
631 631
    return YMap<M>(m);
632 632
  }
633 633

	
634 634
  template<class M> 
635 635
  inline YMap<M> yMap(const M &m) 
636 636
  {
637 637
    return YMap<M>(m);
638 638
  }
639 639

	
640
  ///Constant (read only) version of \ref YMap
640
  ///Constant (read only) version of YMap
641 641

	
642 642
  ///\ingroup maps
643 643
  ///Constant (read only) version of \ref YMap
644 644
  ///
645 645
  template<class M>
646 646
  class ConstYMap 
647 647
  {
648 648
    const M& _map;
649 649
  public:
650 650

	
651 651
    typedef typename M::Value::Value Value;
652 652
    typedef typename M::Key Key;
... ...
@@ -659,26 +659,26 @@
659 659

	
660 660
  ///This function just returns a \ref ConstYMap class.
661 661
  ///
662 662
  ///\ingroup maps
663 663
  ///\relates ConstYMap
664 664
  template<class M> 
665 665
  inline ConstYMap<M> yMap(const M &m) 
666 666
  {
667 667
    return ConstYMap<M>(m);
668 668
  }
669 669

	
670 670

	
671
    ///\brief Map of the \ref Point::normSquare() "normSquare()"
672
    ///of a \ref Point "Point"-map
671
    ///\brief Map of the normSquare()
672
    ///of a Point map
673 673
    ///
674 674
    ///Map of the \ref Point::normSquare() "normSquare()"
675 675
    ///of a \ref Point "Point"-map.
676 676
    ///\ingroup maps
677 677
    ///
678 678
  template<class M>
679 679
  class NormSquareMap 
680 680
  {
681 681
    const M& _map;
682 682
  public:
683 683

	
684 684
    typedef typename M::Value::Value Value;
Ignore white space 6 line context
... ...
@@ -165,31 +165,31 @@
165 165

	
166 166
  ///Map based on std::map
167 167

	
168 168
  ///This is essentially a wrapper for \c std::map with addition that
169 169
  ///you can specify a default value different from \c Value().
170 170
  template <typename K, typename T, typename Compare = std::less<K> >
171 171
  class StdMap {
172 172
    template <typename K1, typename T1, typename C1>
173 173
    friend class StdMap;
174 174
  public:
175 175

	
176 176
    typedef True ReferenceMapTag;
177
    ///\e
177
    ///Key type
178 178
    typedef K Key;
179
    ///\e
179
    ///Value type
180 180
    typedef T Value;
181
    ///\e
181
    ///Reference Type
182 182
    typedef T& Reference;
183
    ///\e
183
    ///Const reference type
184 184
    typedef const T& ConstReference;
185 185

	
186 186
  private:
187 187
    
188 188
    typedef std::map<K, T, Compare> Map;
189 189
    Value _value;
190 190
    Map _map;
191 191

	
192 192
  public:
193 193

	
194 194
    /// Constructor with specified default value
195 195
    StdMap(const T& value = T()) : _value(value) {}
Ignore white space 24 line context
... ...
@@ -32,25 +32,25 @@
32 32
  /// \addtogroup misc
33 33
  /// @{
34 34
  
35 35
  ///\brief A class to provide a basic way to
36 36
  ///handle the comparison of numbers that are obtained
37 37
  ///as a result of a probably inexact computation.
38 38
  ///
39 39
  ///Tolerance is a class to provide a basic way to
40 40
  ///handle the comparison of numbers that are obtained
41 41
  ///as a result of a probably inexact computation.
42 42
  ///
43 43
  ///This is an abstract class, it should be specialized for all numerical
44
  ///data types. These specialized classes like \ref Tolerance\<double\>
44
  ///data types. These specialized classes like Tolerance<double>
45 45
  ///may offer additional tuning parameters.
46 46
  ///
47 47
  ///\sa Tolerance<float>
48 48
  ///\sa Tolerance<double>
49 49
  ///\sa Tolerance<long double>
50 50
  ///\sa Tolerance<int>
51 51
#if defined __GNUC__ && !defined __STRICT_ANSI__  
52 52
  ///\sa Tolerance<long long int>
53 53
#endif
54 54
  ///\sa Tolerance<unsigned int>
55 55
#if defined __GNUC__ && !defined __STRICT_ANSI__  
56 56
  ///\sa Tolerance<unsigned long long int>
... ...
@@ -82,27 +82,27 @@
82 82

	
83 83
    ///@}
84 84

	
85 85
    ///Returns the zero value.
86 86
    static Value zero() {return T();}
87 87

	
88 88
    //   static bool finite(Value a) {}
89 89
    //   static Value big() {}
90 90
    //   static Value negativeBig() {}
91 91
  };
92 92

	
93 93

	
94
  ///Float specialization of \ref Tolerance.
94
  ///Float specialization of Tolerance.
95 95

	
96
  ///Float specialization of \ref Tolerance.
96
  ///Float specialization of Tolerance.
97 97
  ///\sa Tolerance
98 98
  ///\relates Tolerance
99 99
  template<>
100 100
  class Tolerance<float>
101 101
  {
102 102
    static float def_epsilon;
103 103
    float _epsilon;
104 104
  public:
105 105
    ///\e
106 106
    typedef float Value;
107 107

	
108 108
    ///Constructor setting the epsilon tolerance to the default value.
... ...
@@ -133,27 +133,27 @@
133 133
    bool positive(Value a) const { return _epsilon<a; }
134 134
    ///Returns \c true if \c a is \e surely negative
135 135
    bool negative(Value a) const { return -_epsilon>a; }
136 136
    ///Returns \c true if \c a is \e surely non-zero
137 137
    bool nonZero(Value a) const { return positive(a)||negative(a); }
138 138

	
139 139
    ///@}
140 140

	
141 141
    ///Returns zero
142 142
    static Value zero() {return 0;}
143 143
  };
144 144

	
145
  ///Double specialization of \ref Tolerance.
145
  ///Double specialization of Tolerance.
146 146

	
147
  ///Double specialization of \ref Tolerance.
147
  ///Double specialization of Tolerance.
148 148
  ///\sa Tolerance
149 149
  ///\relates Tolerance
150 150
  template<>
151 151
  class Tolerance<double>
152 152
  {
153 153
    static double def_epsilon;
154 154
    double _epsilon;
155 155
  public:
156 156
    ///\e
157 157
    typedef double Value;
158 158

	
159 159
    ///Constructor setting the epsilon tolerance to the default value.
... ...
@@ -184,27 +184,27 @@
184 184
    bool positive(Value a) const { return _epsilon<a; }
185 185
    ///Returns \c true if \c a is \e surely negative
186 186
    bool negative(Value a) const { return -_epsilon>a; }
187 187
    ///Returns \c true if \c a is \e surely non-zero
188 188
    bool nonZero(Value a) const { return positive(a)||negative(a); }
189 189

	
190 190
    ///@}
191 191

	
192 192
    ///Returns zero
193 193
    static Value zero() {return 0;}
194 194
  };
195 195

	
196
  ///Long double specialization of \ref Tolerance.
196
  ///Long double specialization of Tolerance.
197 197

	
198
  ///Long double specialization of \ref Tolerance.
198
  ///Long double specialization of Tolerance.
199 199
  ///\sa Tolerance
200 200
  ///\relates Tolerance
201 201
  template<>
202 202
  class Tolerance<long double>
203 203
  {
204 204
    static long double def_epsilon;
205 205
    long double _epsilon;
206 206
  public:
207 207
    ///\e
208 208
    typedef long double Value;
209 209

	
210 210
    ///Constructor setting the epsilon tolerance to the default value.
... ...
@@ -235,160 +235,160 @@
235 235
    bool positive(Value a) const { return _epsilon<a; }
236 236
    ///Returns \c true if \c a is \e surely negative
237 237
    bool negative(Value a) const { return -_epsilon>a; }
238 238
    ///Returns \c true if \c a is \e surely non-zero
239 239
    bool nonZero(Value a) const { return positive(a)||negative(a); }
240 240

	
241 241
    ///@}
242 242

	
243 243
    ///Returns zero
244 244
    static Value zero() {return 0;}
245 245
  };
246 246

	
247
  ///Integer specialization of \ref Tolerance.
247
  ///Integer specialization of Tolerance.
248 248

	
249
  ///Integer specialization of \ref Tolerance.
249
  ///Integer specialization of Tolerance.
250 250
  ///\sa Tolerance
251 251
  template<>
252 252
  class Tolerance<int>
253 253
  {
254 254
  public:
255 255
    ///\e
256 256
    typedef int Value;
257 257

	
258 258
    ///\name Comparisons
259
    ///See \ref Tolerance for more details.
259
    ///See Tolerance for more details.
260 260

	
261 261
    ///@{
262 262

	
263 263
    ///Returns \c true if \c a is \e surely strictly less than \c b
264 264
    static bool less(Value a,Value b) { return a<b;}
265 265
    ///Returns \c true if \c a is \e surely different from \c b
266 266
    static bool different(Value a,Value b) { return a!=b; }
267 267
    ///Returns \c true if \c a is \e surely positive
268 268
    static bool positive(Value a) { return 0<a; }
269 269
    ///Returns \c true if \c a is \e surely negative
270 270
    static bool negative(Value a) { return 0>a; }
271 271
    ///Returns \c true if \c a is \e surely non-zero
272 272
    static bool nonZero(Value a) { return a!=0; }
273 273

	
274 274
    ///@}
275 275

	
276 276
    ///Returns zero
277 277
    static Value zero() {return 0;}
278 278
  };
279 279

	
280
  ///Unsigned integer specialization of \ref Tolerance.
280
  ///Unsigned integer specialization of Tolerance.
281 281

	
282 282
  ///Unsigned integer specialization of \ref Tolerance.
283 283
  ///\sa Tolerance
284 284
  template<>
285 285
  class Tolerance<unsigned int>
286 286
  {
287 287
  public:
288 288
    ///\e
289 289
    typedef unsigned int Value;
290 290

	
291 291
    ///\name Comparisons
292
    ///See \ref Tolerance for more details.
292
    ///See Tolerance for more details.
293 293

	
294 294
    ///@{
295 295

	
296 296
    ///Returns \c true if \c a is \e surely strictly less than \c b
297 297
    static bool less(Value a,Value b) { return a<b;}
298 298
    ///Returns \c true if \c a is \e surely different from \c b
299 299
    static bool different(Value a,Value b) { return a!=b; }
300 300
    ///Returns \c true if \c a is \e surely positive
301 301
    static bool positive(Value a) { return 0<a; }
302 302
    ///Returns \c true if \c a is \e surely negative
303 303
    static bool negative(Value) { return false; }
304 304
    ///Returns \c true if \c a is \e surely non-zero
305 305
    static bool nonZero(Value a) { return a!=0; }
306 306

	
307 307
    ///@}
308 308

	
309 309
    ///Returns zero
310 310
    static Value zero() {return 0;}
311 311
  };
312 312
  
313 313

	
314
  ///Long integer specialization of \ref Tolerance.
314
  ///Long integer specialization of Tolerance.
315 315

	
316
  ///Long integer specialization of \ref Tolerance.
316
  ///Long integer specialization of Tolerance.
317 317
  ///\sa Tolerance
318 318
  template<>
319 319
  class Tolerance<long int>
320 320
  {
321 321
  public:
322 322
    ///\e
323 323
    typedef long int Value;
324 324

	
325 325
    ///\name Comparisons
326
    ///See \ref Tolerance for more details.
326
    ///See Tolerance for more details.
327 327

	
328 328
    ///@{
329 329

	
330 330
    ///Returns \c true if \c a is \e surely strictly less than \c b
331 331
    static bool less(Value a,Value b) { return a<b;}
332 332
    ///Returns \c true if \c a is \e surely different from \c b
333 333
    static bool different(Value a,Value b) { return a!=b; }
334 334
    ///Returns \c true if \c a is \e surely positive
335 335
    static bool positive(Value a) { return 0<a; }
336 336
    ///Returns \c true if \c a is \e surely negative
337 337
    static bool negative(Value a) { return 0>a; }
338 338
    ///Returns \c true if \c a is \e surely non-zero
339 339
    static bool nonZero(Value a) { return a!=0;}
340 340

	
341 341
    ///@}
342 342

	
343 343
    ///Returns zero
344 344
    static Value zero() {return 0;}
345 345
  };
346 346

	
347
  ///Unsigned long integer specialization of \ref Tolerance.
347
  ///Unsigned long integer specialization of Tolerance.
348 348

	
349 349
  ///Unsigned long integer specialization of \ref Tolerance.
350 350
  ///\sa Tolerance
351 351
  template<>
352 352
  class Tolerance<unsigned long int>
353 353
  {
354 354
  public:
355 355
    ///\e
356 356
    typedef unsigned long int Value;
357 357

	
358 358
    ///\name Comparisons
359
    ///See \ref Tolerance for more details.
359
    ///See Tolerance for more details.
360 360

	
361 361
    ///@{
362 362

	
363 363
    ///Returns \c true if \c a is \e surely strictly less than \c b
364 364
    static bool less(Value a,Value b) { return a<b;}
365 365
    ///Returns \c true if \c a is \e surely different from \c b
366 366
    static bool different(Value a,Value b) { return a!=b; }
367 367
    ///Returns \c true if \c a is \e surely positive
368 368
    static bool positive(Value a) { return 0<a; }
369 369
    ///Returns \c true if \c a is \e surely negative
370 370
    static bool negative(Value) { return false; }
371 371
    ///Returns \c true if \c a is \e surely non-zero
372 372
    static bool nonZero(Value a) { return a!=0;}
373 373

	
374 374
    ///@}
375 375

	
376 376
    ///Returns zero
377 377
    static Value zero() {return 0;}
378 378
  };
379 379

	
380 380
#if defined __GNUC__ && !defined __STRICT_ANSI__
381 381

	
382
  ///Long long integer specialization of \ref Tolerance.
382
  ///Long long integer specialization of Tolerance.
383 383

	
384 384
  ///Long long integer specialization of \ref Tolerance.
385 385
  ///\warning This class (more exactly, type <tt>long long</tt>)
386 386
  ///is not ansi compatible.
387 387
  ///\sa Tolerance
388 388
  template<>
389 389
  class Tolerance<long long int>
390 390
  {
391 391
  public:
392 392
    ///\e
393 393
    typedef long long int Value;
394 394

	
... ...
@@ -405,25 +405,25 @@
405 405
    static bool positive(Value a) { return 0<a; }
406 406
    ///Returns \c true if \c a is \e surely negative
407 407
    static bool negative(Value a) { return 0>a; }
408 408
    ///Returns \c true if \c a is \e surely non-zero
409 409
    static bool nonZero(Value a) { return a!=0;}
410 410

	
411 411
    ///@}
412 412

	
413 413
    ///Returns zero
414 414
    static Value zero() {return 0;}
415 415
  };
416 416

	
417
  ///Unsigned long long integer specialization of \ref Tolerance.
417
  ///Unsigned long long integer specialization of Tolerance.
418 418

	
419 419
  ///Unsigned long long integer specialization of \ref Tolerance.
420 420
  ///\warning This class (more exactly, type <tt>unsigned long long</tt>)
421 421
  ///is not ansi compatible.
422 422
  ///\sa Tolerance
423 423
  template<>
424 424
  class Tolerance<unsigned long long int>
425 425
  {
426 426
  public:
427 427
    ///\e
428 428
    typedef unsigned long long int Value;
429 429

	
0 comments (0 inline)