Make it compile when USE_BOOST_FORMAT is unset

[lyx.git] / src / insets / insetoptarg.h

diff --git a/src/insets/insetoptarg.h b/src/insets/insetoptarg.h
index 7f30ce292d1493b2ae62f807a8e39f3a90969e7f..9256c31bd9fff1bf1822554c89652ec8b5ad157c 100644 (file)
--- a/src/insets/insetoptarg.h
+++ b/src/insets/insetoptarg.h
@@ -1,13 +1,13 @@
 // -*- C++ -*-
-/* This file is part of*
- * ======================================================
+/**
+ * \file insetoptarg.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Martin Vermeer  
  *
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef INSETOPTARG_H
 #define INSETOPTARG_H
@@ -19,27 +19,35 @@
 #include "insettext.h"
 #include "insetcollapsable.h"
 
+
+/**
+ * InsetOptArg. Used to insert a short version of sectioning header etc.
+ * automatically, or other optional LaTeX arguments
+ */
 class InsetOptArg : public InsetCollapsable {
 public:
        InsetOptArg(BufferParams const &);
-       ///
+
        InsetOptArg(InsetOptArg const &, bool same_id = false);
 
+       /// make a duplicate of this inset
        Inset * clone(Buffer const &, bool same_id = false) const;
-       ///
+
+       /// this inset is editable
        EDITABLE editable() const { return IS_EDITABLE; }
-       ///
+       /// code of the inset
        Inset::Code lyxCode() const { return Inset::OPTARG_CODE; }
-       ///
+       /// return an message upon editing
        string const editMessage() const;
+
        /// Standard LaTeX output -- short-circuited
-       int latex(Buffer const *, std::ostream &, 
+       int latex(Buffer const *, std::ostream &,
                                        bool fragile, bool fp) const;
        /// Outputting the optional parameter of a LaTeX command
-       int latexOptional(Buffer const *, std::ostream &, 
+       int latexOptional(Buffer const *, std::ostream &,
                                        bool fragile, bool fp) const;
-       ///
-       void write(Buffer const * buf, ostream & os) const;
+       /// Write out tothe .lyx file
+       void write(Buffer const * buf, std::ostream & os) const;
 };
 
-#endif
+#endif // INSETOPTARG_H