|
ContRap-Core
|
This file is a part of ContRap. More...
#include <string>Functions | |
| void | library_index (const std::string &output_path) |
| Creates the index file of all libraries using the cache. | |
| void | library_documentation (const std::string &library_file, const std::string &output_path) |
| Creates the documentation files for a given library file. | |
This file is a part of ContRap.
Copyright (c) 2009-2010 by Aless Lasaruk. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of ContRap nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This file contains the documentation generator of ContRap
| void library_documentation | ( | const std::string & | library_file, |
| const std::string & | output_path | ||
| ) |
Creates the documentation files for a given library file.
| library_file | Full path to a contrap library |
| output_path | Path to a directory where the documentation should be placed |
| void library_index | ( | const std::string & | output_path | ) |
Creates the index file of all libraries using the cache.
| output_path | Path to a directory where the documentation should be placed |
1.7.3