include sys/time.h

[lyx.git] / src / vspace.h

diff --git a/src/vspace.h b/src/vspace.h
index 266e04196da2c6ebf9a674fcc3adb22f30c99604..95b68bfe7efb1b5346daabffe5ff7ace0fa0f55c 100644 (file)
--- a/src/vspace.h
+++ b/src/vspace.h
@@ -1,21 +1,15 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file vspace.h
+ * Copyright 1995-2002 the LyX Team
+ * Read the file COPYING
  *
- *           LyX, The Document Processor
- *     
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+ * \author Matthias Ettrich
+ */
 
 #ifndef VSPACE_H
 #define VSPACE_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "lyxgluelength.h"
 
 #include "LString.h"
@@ -24,64 +18,58 @@ class BufferParams;
 class BufferView;
 
 
-///
+/// A class representing latex vertical spacing
 class VSpace {
 public:
        /// The different kinds of spaces.
        enum vspace_kind {
-               ///
-               NONE,
-               ///
+               NONE, ///< no added vertical space
                DEFSKIP,
-               ///
                SMALLSKIP,
-               ///
                MEDSKIP,
-               ///
                BIGSKIP,
-               ///
                VFILL,
-               ///
-               LENGTH
+               LENGTH ///< user-defined length
        };
-       /// Constructor
+
        VSpace();
-       /// Constructor
+
        explicit VSpace(vspace_kind k);
-       /// Constructor
+
        explicit VSpace(LyXLength const & l);
-       /// Constructor
+
        explicit VSpace(LyXGlueLength const & l);
 
        /// Constructor for reading from a .lyx file
        explicit VSpace(string const & data);
-       
-       /// access functions
+
+       /// return the type of vertical space
        vspace_kind kind() const;
-       ///
+       /// return the length of this space
        LyXGlueLength length() const;
 
        // a flag that switches between \vspace and \vspace*
        bool keep() const;
-       ///
+       /// if set true, use \vspace* when type is not DEFSKIP
        void setKeep(bool val);
        ///
        bool operator==(VSpace const &) const;
 
        // conversion
+
        /// how it goes into the LyX file
-       string const asLyXCommand() const; 
-       ///
+       string const asLyXCommand() const;
+       /// the latex representation
        string const asLatexCommand(BufferParams const & params) const;
-       ///
-       int inPixels(BufferView * bv) const;
+       /// the size of the space on-screen
+       int inPixels(BufferView const * bv) const;
 private:
        /// This VSpace kind
        vspace_kind kind_;
-       ///
+       /// the specified length
        LyXGlueLength len_;
-       ///
+       /// if true, use \vspace* type
        bool keep_;
 };
 
-#endif
+#endif // VSPACE_H