PLearn 0.1
|
00001 // -*- C++ -*- 00002 00003 // HTMLHelpGenerator.h 00004 // 00005 // Copyright (C) 2007 Xavier Saint-Mleux, ApSTAT Technologies inc. 00006 // 00007 // Redistribution and use in source and binary forms, with or without 00008 // modification, are permitted provided that the following conditions are met: 00009 // 00010 // 1. Redistributions of source code must retain the above copyright 00011 // notice, this list of conditions and the following disclaimer. 00012 // 00013 // 2. Redistributions in binary form must reproduce the above copyright 00014 // notice, this list of conditions and the following disclaimer in the 00015 // documentation and/or other materials provided with the distribution. 00016 // 00017 // 3. The name of the authors may not be used to endorse or promote 00018 // products derived from this software without specific prior written 00019 // permission. 00020 // 00021 // THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR 00022 // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00023 // OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 00024 // NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00025 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 00026 // TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 00027 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 00028 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 00029 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 00030 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 00031 // 00032 // This file is part of the PLearn library. For more information on the PLearn 00033 // library, go to the PLearn Web site at www.plearn.org 00034 00035 // Authors: Xavier Saint-Mleux 00036 00040 #ifndef HTMLHelpGenerator_INC 00041 #define HTMLHelpGenerator_INC 00042 00043 #include <plearn/base/Object.h> 00044 00045 namespace PLearn { 00046 00057 class HTMLHelpGenerator : public Object 00058 { 00059 typedef Object inherited; 00060 00061 public: 00062 //##### Public Build Options ############################################ 00063 00066 00068 PPath output_dir; 00069 00072 PPath resources_dir; 00073 00074 public: 00075 //##### Public Member Functions ######################################### 00076 00078 HTMLHelpGenerator(const PPath& output_dir_= "", 00079 const PPath& resources_dir_= ""); 00080 00081 virtual void run(); 00082 00083 void helpCommands(); 00084 void helpFunctions(); 00085 void helpClasses(); 00086 00087 //##### PLearn::Object Protocol ######################################### 00088 00089 // Declares other standard object methods. 00090 PLEARN_DECLARE_OBJECT(HTMLHelpGenerator); 00091 00092 virtual void build(); 00093 00094 virtual void makeDeepCopyFromShallowCopy(CopiesMap& copies); 00095 00096 protected: 00097 //##### Protected Options ############################################### 00098 00099 protected: 00100 //##### Protected Member Functions ###################################### 00101 00103 static void declareOptions(OptionList& ol); 00104 00105 private: 00106 //##### Private Member Functions ######################################## 00107 00109 void build_(); 00110 00111 private: 00112 //##### Private Data Members ############################################ 00113 00114 }; 00115 00116 DECLARE_OBJECT_PTR(HTMLHelpGenerator); 00117 00118 } // end of namespace PLearn 00119 00120 #endif 00121 00122 00123 /* 00124 Local Variables: 00125 mode:c++ 00126 c-basic-offset:4 00127 c-file-style:"stroustrup" 00128 c-file-offsets:((innamespace . 0)(inline-open . 0)) 00129 indent-tabs-mode:nil 00130 fill-column:79 00131 End: 00132 */ 00133 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=79 :