(SARBayes)	Main	Class List	Hierarchy	Methods	Files	Related Pages

Cover and Table of Contents

The SORAL Developer's Manual

Version 1.2

Date:

13 Jan 2003

Todo:

The Developer's Manual has not been updated for the second code review! Some of it is wrong.

Use an auto-date feature for the date on this page?

Table of contents

1. Introduction
2. SORAL Library Structure
   • Review of what SORAL does
   • SORAL Structure
   • Future Plans and Ideas
3. Documentation Standard
   • Documentation Tools
     • Dia
     • dOxygen
   • Source Code Commenting
     • File Header Block
     • Class Header Block
     • Property / Method description
     • Other useful dOxygen Commands:
     • Maintenance comment
4. The Coding Standard
5. Configuration Management
   • Policy
   • Setting up CVS for Write Access
     • Creating a password:
     • The first login / check out:
   • Using CVS
     • Editing the code:
     • Updating the repository:
     • Updating your local source:
     • Other Options
6. Writing New Allocation Algorithms
   • Why you may want to create a new allocation object
   • How to create a new allocation object
     • Friend Function
     • Using the containers

---

(SARBayes)	Main	Class List	Hierarchy	Methods	Files	Related Pages