Qore Qdx Module Reference  1.0
Qdx.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
2 // @file Qdx.qm Qore user module for documentation generation with doxygen
3 
4 /* Qdx.qm Copyright 2016 - 2017 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
25 
26 
27 
28 
53 namespace Qdx {
57 
58 public:
59  private:internal {
60  bool css = False;
61  bool inTable = False;
62  }
63 
64  // no public members
65 private:
66 
67 public:
68 
70 
74  string process(string line);
75 
76  };
77 
80 
81 public:
91  constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim = True) ;
92 
93 
95 
107  string getLine();
108 
109 
111 
123  string getValue();
124 
125  };
126 
129 
130 public:
140  constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim = False) ;
141 
142 
151  constructor(Qore::StreamReader sr, *string eol, bool do_trim = False) ;
152 
153 
155 
167  string getLine();
168 
169 
171 
183  string getValue();
184 
185  };
186 
189 
190 public:
200  constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim = False) ;
201 
202 
211  constructor(Qore::StreamReader sr, *string eol, bool do_trim = False) ;
212 
213 
215 
227  string getLine();
228 
229 
231 
243  string getValue();
244 
245  };
246 };
converts specially-formatted text in the input to HTML tables
Definition: Qdx.qm.dox.h:56
const True
string getLine()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
string getValue()
Returns the current line in the data or throws an ITERATOR-ERROR exception if the iterator is invalid...
a line-based input stream iterator that converts specially-formatted input line text to HTML table ou...
Definition: Qdx.qm.dox.h:79
const False
a line-based input stream iterator for post-processing HTML and JS files created for Qore documentati...
Definition: Qdx.qm.dox.h:128
string process(string line)
accepts an input line and returns the formatted output line
the Qdx namespace contains all the objects in the Qdx module
Definition: Qdx.qm.dox.h:54
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim=True)
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim=False)
string getLine()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
string getValue()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
string getValue()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
string getLine()
Returns the current line in the data or throws an ITERATOR-ERROR exception if the iterator is invalid...
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim=False)
a line-based input stream iterator for post-processing HTML and JS files created for Qore documentati...
Definition: Qdx.qm.dox.h:188