From 9941c3c1d754a2154811943c0a7e937d8da59bae Mon Sep 17 00:00:00 2001
From: Manolo Gouy <Manolo>
Date: Sat, 23 Apr 2016 17:52:34 +0000
Subject: Move Doxygen comments of Fl_PostScript_File_Device members to
 Fl_PostScript_File_Device.H for Doxygen visibility.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3-porting@11687 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
---
 FL/Fl_PostScript.H | 31 +++++++++++++++++++++++++++++--
 1 file changed, 29 insertions(+), 2 deletions(-)

(limited to 'FL/Fl_PostScript.H')

diff --git a/FL/Fl_PostScript.H b/FL/Fl_PostScript.H
index 5f185fed5..e9b047fa5 100644
--- a/FL/Fl_PostScript.H
+++ b/FL/Fl_PostScript.H
@@ -230,12 +230,38 @@ class FL_EXPORT Fl_PostScript_File_Device : public Fl_Paged_Device {
 protected:
   Fl_PostScript_Graphics_Driver *driver();
 public:
+  /**
+   @brief The constructor.
+   */
   Fl_PostScript_File_Device();
+  /**
+   @brief The destructor.
+   */
   ~Fl_PostScript_File_Device();
+  /** Don't use with this class. */
   int start_job(int pagecount, int* from, int* to);
+  /**
+   @brief Begins the session where all graphics requests will go to a local PostScript file.
+   *
+   Opens a file dialog entitled with Fl_PostScript_File_Device::file_chooser_title to select an output PostScript file.
+   @param pagecount The total number of pages to be created. Use 0 if this number is unknown when this function is called.
+   @param format Desired page format.
+   @param layout Desired page layout.
+   @return 0 if OK, 1 if user cancelled the file dialog, 2 if fopen failed on user-selected output file.
+   */
   int start_job(int pagecount, enum Fl_Paged_Device::Page_Format format = Fl_Paged_Device::A4,
 		enum Fl_Paged_Device::Page_Layout layout = Fl_Paged_Device::PORTRAIT);
-  int start_job(FILE *ps_output, int pagecount, enum Fl_Paged_Device::Page_Format format = Fl_Paged_Device::A4, 
+  /**
+   @brief Begins the session where all graphics requests will go to FILE pointer.
+   *
+   @param ps_output A writable FILE pointer that will receive PostScript output and that should not be closed
+   until after end_job() has been called.
+   @param pagecount The total number of pages to be created. Use 0 if this number is unknown when this function is called.
+   @param format Desired page format.
+   @param layout Desired page layout.
+   @return always 0.
+   */
+  int start_job(FILE *ps_output, int pagecount, enum Fl_Paged_Device::Page_Format format = Fl_Paged_Device::A4,
 		enum Fl_Paged_Device::Page_Layout layout = Fl_Paged_Device::PORTRAIT);
   int start_page (void);
   int printable_rect(int *w, int *h);
@@ -248,7 +274,8 @@ public:
   void untranslate(void);
   int end_page (void);    
   void end_job(void);  
-  static const char *file_chooser_title; 
+  /** \brief Label of the PostScript file chooser window */
+  static const char *file_chooser_title;
 };
 
 #endif // Fl_PostScript_H
-- 
cgit v1.2.3