| Contributor: | Adam Erickson |
|
| Date: | February 19, 2010 | |
| Description: | NaturalDocs HTML Documentation GeneratorThis kit provides a modified version of the open-source Natural Docs documentation generator, configuration files, images, and scripts used to generate the OVM Online Documentation. Using the OVM source used as input, you can generate the same online documentation you see at OVM World. More importantly, you can use the OVM reference as a template for generating your own documentation. To generate OVM documentation, run the .../ovm/docs/ovm_ref/nd/gen_nd script after reading the documentation contained within it. Another good example of ND usage is the recently contributed OVM-VMM Interoperability Supplemental Kit (see www.ovmworld.org/contributions.php). It uses custom inline-code tags to insert code snippets and complete code examples directly into the HTML documentation. All ND documentation for both users and developers is found at naturaldocs.org. From naturaldocs.org: Natural Docs is an open-source documentation generator. You document your code in a natural syntax that reads like plain English. Natural Docs then scans your code and builds high-quality HTML documentation from it. Natural Docs and its derivatives, including this work, are licensed under the GNU General Public License (GPL): This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, visit http://www.gnu.org/licenses/gpl.txt or write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. |
|
| Download: | ovm_natural_docs.tar_0.gz |