| /* |
| * Copyright 2008 Sony Corporation of America |
| * |
| * |
| * 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. |
| */ |
| |
| MARS Doxygen README |
| |
| |
| Overview |
| ======== |
| |
| The MARS doxygen directory containt the sources used to generate a set of |
| documents that describe the MARS (Multicore Application Runtime System) library. |
| |
| The actual documentation is automatically generated by Doxygen. The doxygen |
| comments are found in the MARS library source headers. The files in this package |
| provide only the source files needed to generate the final documentation. |
| |
| When distributing the documentation, only the generated documentation and |
| appropriate license file should be distributed. |
| |
| /doxygen |
| | |
| |---/src Contains all the sources needed to generate distributable docs |
| |
| |
| Building |
| ======== |
| |
| - The build requires both doxygen and rsvg-convert. |
| |
| - To build all the docs, run 'make' |
| |
| - To clean the generated docs, run 'make clean' |
| |
| - To create a distributable tarball of the docs sources, run 'make dist' |
| |
| - To create a distributable tarball of the generated docs, run 'make docs-dist' |
