Mention that the renderer's alignment is ignored under OS X, reorder docs

[wxWidgets.git] / interface / process.h

diff --git a/interface/process.h b/interface/process.h
index d77a129e7e0def1e269b0c410cf2ad4cff0d6d01..d0bffe92dbe67d756047443c05d7de872258bc58 100644 (file)
--- a/interface/process.h
+++ b/interface/process.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        process.h
-// Purpose:     documentation for wxProcess class
+// Purpose:     interface of wxProcess
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -11,7 +11,7 @@
     @wxheader{process.h}
 
     The objects of this class are used in conjunction with the
-    wxExecute function. When a wxProcess object is passed to
+    wxExecute() function. When a wxProcess object is passed to
     wxExecute(), its wxProcess::OnTerminate virtual method
     is called when the process terminates. This allows the program to be
     (asynchronously) notified about the process termination and also retrieve its
@@ -26,7 +26,7 @@
 
     wxProcess also supports IO redirection of the child process. For this, you have
     to call its wxProcess::Redirect method before passing it to
-    wxExecute. If the child process was launched successfully,
+    wxExecute(). If the child process was launched successfully,
     wxProcess::GetInputStream,
     wxProcess::GetOutputStream and
     wxProcess::GetErrorStream can then be used to retrieve
@@ -39,8 +39,7 @@
     @library{wxbase}
     @category{appmanagement}
 
-    @seealso
-    wxExecute, @ref overview_sampleexec "exec sample"
+    @see wxExecute(), @ref overview_sampleexec "exec sample"
 */
 class wxProcess : public wxEvtHandler
 {
@@ -58,7 +57,7 @@ public:
         value of @c wxPROCESS_DEFAULT or @c wxPROCESS_REDIRECT. Specifying the
         former value has no particular effect while using the latter one is equivalent
         to calling Redirect().
-        
+
         @param parent
             The event handler parent.
         @param id
@@ -98,7 +97,7 @@ public:
 
     /**
         Returns @true if the given process exists in the system.
-        
+
         @see Kill(), @ref overview_sampleexec "Exec sample"
     */
     static bool Exists(int pid);
@@ -107,34 +106,34 @@ public:
         Returns an input stream which corresponds to the standard error output (stderr)
         of the child process.
     */
-    wxInputStream* GetErrorStream();
+    wxInputStream* GetErrorStream() const;
 
     /**
         It returns an input stream corresponding to the standard output stream of the
         subprocess. If it is @NULL, you have not turned on the redirection.
         See Redirect().
     */
-    wxInputStream* GetInputStream();
+    wxInputStream* GetInputStream() const;
 
     /**
         It returns an output stream correspoding to the input stream of the subprocess.
         If it is @NULL, you have not turned on the redirection.
         See Redirect().
     */
-    wxOutputStream* GetOutputStream();
+    wxOutputStream* GetOutputStream() const;
 
     /**
         Returns the process ID of the process launched by Open().
     */
-    long GetPid();
+    long GetPid() const;
 
     /**
         Returns @true if there is data to be read on the child process standard
         error stream.
-        
+
         @see IsInputAvailable()
     */
-    bool IsErrorAvailable();
+    bool IsErrorAvailable() const;
 
     /**
         Returns @true if there is data to be read on the child process standard
@@ -142,19 +141,19 @@ public:
         polling-based code waiting for a better mechanism in future wxWidgets versions.
         See the @ref overview_sampleexec "exec sample" for an example of using this
         function.
-        
+
         @see IsInputOpened()
     */
-    bool IsInputAvailable();
+    bool IsInputAvailable() const;
 
     /**
         Returns @true if the child process standard output stream is opened.
     */
-    bool IsInputOpened();
+    bool IsInputOpened() const;
 
     /**
         Send the specified signal to the given process. Possible signal values are:
-        
+
         @c wxSIGNONE, @c wxSIGKILL and @c wxSIGTERM have the same meaning
         under both Unix and Windows but all the other signals are equivalent to
         @c wxSIGTERM under Windows.
@@ -163,18 +162,18 @@ public:
         process will be killed too. Note that under Unix, for wxKILL_CHILDREN
         to work you should have created the process passing wxEXEC_MAKE_GROUP_LEADER.
         Returns the element of @c wxKillError enum:
-        
-        @see Exists(), wxKill, @ref overview_sampleexec "Exec sample"
+
+        @see Exists(), wxKill(), @ref overview_sampleexec "Exec sample"
     */
     static wxKillError Kill(int pid, wxSignal signal = wxSIGNONE,
                             int flags = wxKILL_NOCHILDREN);
 
     /**
         It is called when the process with the pid
-        
+
         @param pid finishes.
         It raises a wxWidgets event when it isn't overridden.
-        
+
         pid
             The pid of the process which has just terminated.
         @param status
@@ -192,16 +191,16 @@ public:
         object will be destroyed automatically when the child process terminates. This
         does mean that the child process should be told to quit before the main program
         exits to avoid memory leaks.
-        
+
         @param cmd
             The command to execute, including optional arguments.
         @param flags
             The flags to pass to wxExecute.
               NOTE: wxEXEC_SYNC should not be used.
-        
+
         @returns A pointer to new wxProcess object or @NULL on error.
-        
-        @see wxExecute
+
+        @see wxExecute()
     */
     static wxProcess* Open(const wxString& cmd,
                            int flags = wxEXEC_ASYNC);
@@ -216,6 +215,7 @@ public:
 };
 
 
+
 /**
     @class wxProcessEvent
     @wxheader{process.h}
@@ -225,8 +225,7 @@ public:
     @library{wxbase}
     @category{events}
 
-    @seealso
-    wxProcess, @ref overview_eventhandlingoverview
+    @see wxProcess, @ref overview_eventhandlingoverview
 */
 class wxProcessEvent : public wxEvent
 {
@@ -245,5 +244,6 @@ public:
     /**
         Returns the process id.
     */
-    int GetPid();
+    int GetPid() const;
 };
+