Point fix, earlier forgotten

[lyx.git] / src / lyx_main.h

diff --git a/src/lyx_main.h b/src/lyx_main.h
index 0b9f38adb8da7375c582af25972b91a9c7512765..0c1fc0b462cb11a813f471c10f415615ef25b358 100644 (file)
--- a/src/lyx_main.h
+++ b/src/lyx_main.h
@@ -1,42 +1,39 @@
 // -*- C++ -*-
 /**
  * \file lyx_main.h
- * Copyright 2002 the LyX Team
- * Read the file COPYING
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- * \author unknown
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef LYX_MAIN_H
 #define LYX_MAIN_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "LString.h"
+#include "errorlist.h"
 
 #include <boost/scoped_ptr.hpp>
 #include <boost/utility.hpp>
 
 #include <csignal>
 
+
 class LyXRC;
 class LastFiles;
 class Buffer;
 class kb_keymap;
 
- 
-///
-extern string user_lyxdir;
-///
-extern string system_lyxdir;
-///
-extern string system_tempdir;
-///
+
+/// last files loaded
 extern boost::scoped_ptr<LastFiles> lastfiles;
- 
 
+
+/// initial startup
 class LyX : boost::noncopyable {
 public:
        LyX(int & argc, char * argv[]);
@@ -45,32 +42,31 @@ public:
        static void emergencyCleanup();
 
 private:
-       /// does this user start lyx for the first time?
-       bool first_start;
-       ///
-       string batch_command;
-       ///
-       void runtime();
-       ///
+       /// initial LyX set up
        void init(bool);
-       ///
+       /// set up the default key bindings
        void defaultKeyBindings(kb_keymap * kbmap);
-       ///
+       /// set up the default dead key bindings if requested
        void deadKeyBindings(kb_keymap * kbmap);
-       ///
+       /// check, set up and configure the user dir if necessary
        void queryUserLyXDir(bool explicit_userdir);
-       /** Search for and read the LyXRC file name, return
-           true if successfull.
-       */
-       bool readRcFile(string const & name);
-       /// Read the ui file `name'
+       /// read lyxrc/preferences
+       void readRcFile(string const & name);
+       /// read the given ui (menu/toolbar) file
        void readUIFile(string const & name);
-       /// Read the languages file `name'
+       /// read the given languages file
        void readLanguagesFile(string const & name);
-       /// Read the encodings file `name'
+       /// read the given encodings file
        void readEncodingsFile(string const & name);
-       ///
+       /// parsing of non-gui LyX options. Returns true if gui
        bool easyParse(int & argc, char * argv[]);
+       /// shows up a parsing error on screen
+       void printError(ErrorItem const &);
+
+       /// has this user started lyx for the first time?
+       bool first_start;
+       /// the parsed command line batch command if any
+       string batch_command;
 };
 
-#endif
+#endif // LYX_MAIN_H