Qdx.qm.dox.h
// -*- mode: c++; indent-tabs-mode: nil -*-
// @file Qdx.qm Qore user module for documentation generation with doxygen
/* Qdx.qm Copyright 2016 - 2017 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
namespace Qdx {
class DocumentTableHelper {
public:
private:internal {
bool css = False;
bool inTable = False;
}
// no public members
private:
public:
string process(string line);
};
class DocumentTableInputStreamLineIterator : public Qore::InputStreamLineIterator, private:internal DocumentTableHelper {
public:
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim = True) ;
string getLine();
string getValue();
};
class QorePostProcessingInputStreamLineIterator : public Qore::InputStreamLineIterator {
public:
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim = False) ;
constructor(Qore::StreamReader sr, *string eol, bool do_trim = False) ;
string getLine();
string getValue();
};
class QorePostProcessingTexInputStreamLineIterator : public QorePostProcessingInputStreamLineIterator {
public:
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim = False) ;
constructor(Qore::StreamReader sr, *string eol, bool do_trim = False) ;
string getLine();
string getValue();
};
};
Qdx::DocumentTableHelper
converts specially-formatted text in the input to HTML tables
Definition: Qdx.qm.dox.h:56
True
const True
Qdx::QorePostProcessingInputStreamLineIterator::getLine
string getLine()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
Qdx::DocumentTableInputStreamLineIterator::getValue
string getValue()
Returns the current line in the data or throws an ITERATOR-ERROR exception if the iterator is invalid...
Qdx::DocumentTableInputStreamLineIterator
a line-based input stream iterator that converts specially-formatted input line text to HTML table ou...
Definition: Qdx.qm.dox.h:79
False
const False
Qdx::QorePostProcessingInputStreamLineIterator
a line-based input stream iterator for post-processing HTML and JS files created for Qore documentati...
Definition: Qdx.qm.dox.h:128
Qore::StreamReader
Qdx::DocumentTableHelper::process
string process(string line)
accepts an input line and returns the formatted output line
Qdx
the Qdx namespace contains all the objects in the Qdx module
Definition: Qdx.qm.dox.h:54
Qdx::DocumentTableInputStreamLineIterator::constructor
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim=True)
Qore::InputStreamLineIterator
Qdx::QorePostProcessingInputStreamLineIterator::constructor
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim=False)
Qdx::QorePostProcessingTexInputStreamLineIterator::getLine
string getLine()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
Qdx::QorePostProcessingTexInputStreamLineIterator::getValue
string getValue()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
Qdx::QorePostProcessingInputStreamLineIterator::getValue
string getValue()
Returns the processed version of the current line in the input data or throws an ITERATOR-ERROR excep...
Qdx::DocumentTableInputStreamLineIterator::getLine
string getLine()
Returns the current line in the data or throws an ITERATOR-ERROR exception if the iterator is invalid...
Qore::InputStream
Qdx::QorePostProcessingTexInputStreamLineIterator::constructor
constructor(Qore::InputStream is, *string encoding, *string eol, bool do_trim=False)
Qdx::QorePostProcessingTexInputStreamLineIterator
a line-based input stream iterator for post-processing HTML and JS files created for Qore documentati...
Definition: Qdx.qm.dox.h:188