| Documentation
|
The code in our repositories includes structured comments which can be parsed by Doxygen to produce HTML documentation. This documentation includes details of the code itself (classes, functions, variables, libraries...), and details of how to check out and build the code. The libraries which currently have such documentation are:
- A set of C++ libraries and executables built with CMake and UnitTest++.
- Code used to test using SCons for C++.
- A set of files (not for compiling) to test Doxygen mark up.
Further documentation is being produced to provide guides to such things as code style, Doxygen comment styles and development methodologies. These guides
are developed with LyX and produced in PDF, which will be made available through this wiki.
|
|
| Tool Information
|
During the development of our code we use tools to hopefully make development easier and more consistent. We break the tools up into 5 sections:
- Covers tools such as vi or vim, Microsoft Visual Studio and Eclipse.
- Includes tools that configure, compile and link like SCons, or those that just configure like CMake, and those that just compile and link like make or Microsoft Visual Studio.
- Tools (usually libraries) that help with testing code, such as UnitTest++ and JUnit, and also Buildbot to run nightly code builds.
- Includes the tools Microsoft Visual Studio, gdb, jdb, Eclipse and Valgrind, as well as the Mantis bugtracker.
- Includes tools used for creating documentation such as Doxygen and LyX.
|
|
| Contribute
|
There are a few ways you can contribute and become part of the MereIdea Wiki Community.
- Give feedback about the blog, wiki, code, or anything else you like or dislike about all things MereIdea.
- Make suggestions for subjects for the blog or suggest things to add to the wiki.
- Become a contributor to the wiki by registering and requesting editing rights. Help us get rid of some red links!
- Work on one of our guides to produce PDF documents on general development subjects.
- Offer to write a blog post on a development subject.
- At present we are not looking for code developers, but we will be in future as this is an open source project. Check back for further details.
|
|
