]> git.lyx.org Git - lyx.git/blobdiff - src/support/systemcall.h
fix compiler warnings about unused parameter
[lyx.git] / src / support / systemcall.h
index 6d44010db8eeecf64b009d1ddbd50ec8eac15d3a..8702283f1a3b3101bdc3ca702d5d0500cc17a3af 100644 (file)
@@ -1,14 +1,26 @@
 // -*- C++ -*-
 /**
- *  \file systemcall.h
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+ * \file systemcall.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
  * \author Asger Alstrup
  *
  * Interface cleaned up by
- * \author Angus Leeming <a.leeming@ic.ac.uk>
+ * \author Angus Leeming
  *
+ * Full author contact details are available in file CREDITS.
+ */
+
+#ifndef SYSTEMCALL_H
+#define SYSTEMCALL_H
+
+#include <string>
+
+namespace lyx {
+namespace support {
+
+/**
  * An instance of Class Systemcall represents a single child process.
  *
  * Class Systemcall uses system() to launch the child process.
  * The child process is not killed when the Systemcall instance goes out of
  * scope.
  */
-
-#ifndef SYSTEMCALL_H
-#define SYSTEMCALL_H
-
-#include "LString.h"
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 class Systemcall {
 public:
-       ///
+       /// whether to wait for completion
        enum Starttype {
-               ///
-               Wait,
-               ///
-               DontWait
+               Wait, //< wait for completion before returning from startscript()
+               DontWait //< don't wait for completion
        };
-       
-#if 0
-       ///
-       Systemcall() {}
 
-       /** Generate instance and start child process.
-        *  The string "what" contains a commandline with arguments separated 
-        *  by spaces.
-        */
-       Systemcall(Starttype how, string const & what);
-#endif
-       
        /** Start child process.
-        *  The string "what" contains a commandline with arguments separated 
+        *  The string "what" contains a commandline with arguments separated
         *  by spaces.
         */
-       int startscript(Starttype how, string const & what);
+       int startscript(Starttype how, std::string const & what);
 };
 
+} // namespace support
+} // namespace lyx
+
 #endif // SYSTEMCALL_H