gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Documentation cleanup.
0 1 0
default
1 file changed with 3 insertions and 3 deletions:
↑ Collapse diff ↑
Show white space 48 line context
... ...
@@ -3,52 +3,52 @@
3 3
 * This file is a part of LEMON, a generic C++ optimization library
4 4
 *
5 5
 * Copyright (C) 2003-2007
6 6
 * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
7 7
 * (Egervary Research Group on Combinatorial Optimization, EGRES).
8 8
 *
9 9
 * Permission to use, modify and distribute this software is granted
10 10
 * provided that this copyright notice appears in all copies. For
11 11
 * precise terms see the accompanying LICENSE file.
12 12
 *
13 13
 * This software is provided "AS IS" with no warranty of any kind,
14 14
 * express or implied, and with no claim as to its suitability for any
15 15
 * purpose.
16 16
 *
17 17
 */
18 18

	
19 19
#ifndef LEMON_BITS_INVALID_H
20 20
#define LEMON_BITS_INVALID_H
21 21

	
22 22
///\file
23 23
///\brief Definition of INVALID.
24 24

	
25 25
namespace lemon {
26 26

	
27
  /// \brief Dummy type to make it easier to make invalid iterators.
27
  /// \brief Dummy type to make it easier to create invalid iterators.
28 28
  ///
29 29
  /// See \ref INVALID for the usage.
30 30
  struct Invalid {
31 31
  public:
32 32
    bool operator==(Invalid) { return true;  }
33 33
    bool operator!=(Invalid) { return false; }
34 34
    bool operator< (Invalid) { return false; }
35 35
  };
36 36
  
37
  /// Invalid iterators.
38
  
37
  /// \brief Invalid iterators.
38
  ///
39 39
  /// \ref Invalid is a global type that converts to each iterator
40 40
  /// in such a way that the value of the target iterator will be invalid.
41 41

	
42 42
  //Some people didn't like this:
43 43
  //const Invalid &INVALID = *(Invalid *)0;
44 44

	
45 45
#ifdef LEMON_ONLY_TEMPLATES
46 46
  const Invalid INVALID = Invalid();
47 47
#else
48 48
  extern const Invalid INVALID;
49 49
#endif
50 50

	
51 51
} //namespace lemon
52 52

	
53 53
#endif
54 54
  
0 comments (0 inline)