/usr/include/OTB-6.4/otbWrapperApplicationHtmlDocGenerator.h is in libotb-dev 6.4.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | /*
* Copyright (C) 2005-2017 Centre National d'Etudes Spatiales (CNES)
*
* This file is part of Orfeo Toolbox
*
* https://www.orfeo-toolbox.org/
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef otbWrapperApplicationHtmlDocGenerator_h
#define otbWrapperApplicationHtmlDocGenerator_h
#include "otbWrapperApplication.h"
namespace otb
{
namespace Wrapper
{
/** \class ApplicationHtmlDocGenerator
* \brief This class genertaes the documentation of a class usung the
* class doc attributes.
*
* \ingroup OTBApplicationEngine
*/
class OTBApplicationEngine_EXPORT ApplicationHtmlDocGenerator
{
public:
/** Standard class typedef */
typedef ApplicationHtmlDocGenerator Self;
/** Constructor */
ApplicationHtmlDocGenerator();
/** Destructor */
virtual ~ApplicationHtmlDocGenerator();
/** Generate ans dave the documentation. */
/** Add the key is the description of the parameter if showKey is
* set at true. */
static void GenerateDoc( const Application::Pointer app, const std::string & filename, const bool showKey = false );
/** Generate the documentation as a string. */
/** Add the key is the description of the parameter if showKey is
* set at true. */
static void GenerateDoc( const Application::Pointer app, std::string & val, const bool showKey = false);
protected:
/** Get the parameter description of one parameter. */
/** Add the key is the description of the parameter if showKey is
* set at true. */
static void GetDocParameters( const Application::Pointer app, std::string & val, const bool showKey = false );
/** generate the documentation associated to a group.*/
/** Add the key is the description of the parameter if showKey is
* set at true. */
static void GetDocParameterGroup( const Application::Pointer app, std::string & val, const std::string & key, const bool showKey = false );
/** generate the documentation associated to a choice.*/
/** Add the key is the description of the parameter if showKey is
* set at true. */
static void GetDocParameterChoice( const Application::Pointer app, std::string & val, const std::string & key, const bool showKey = false );
private:
ApplicationHtmlDocGenerator(const ApplicationHtmlDocGenerator &); //purposely not implemented
void operator =(const ApplicationHtmlDocGenerator&); //purposely not implemented
}; // End class InputImage Parameter
} // End namespace Wrapper
} // End namespace otb
#endif
|