Main Page   Class Hierarchy   Compound List   File List   Compound Members   File Members

Nachos Documentation

Navigating this package

At the top of tihs page you will find six topics. Each of them will redirect you to a specific page, letting you browse Nachos in different ways. Below follows a short description what each topic will show you.

• Main Page: This page

• Class Hierarchy: You will see a list of all classes defined in Nachos. Clicking a specific class will take you to the documentation page that describes the class you have selected.

• Compound List: You will see a list of all classes and structures, together with a brief description of each class/structure. Clicking a specific class/structure will take you to the documentation page that describes the class/structure you have selected.

• File List: You will see a list af all files within the Nachos system.

• Compound Members: You will see an alphabethically ordered list, showing the functions, methods and variables within Nachos. Together with each list item, a link to the corresponding class/structure will be shown.

• File Members: You will see an alphabethically ordered list, showing the functions, methods and variables within Nachos. Together with each list item, a link to the corresponding file will be shown.

Commenting Nachos

• Replace comment delimiters (//.. and  /*..*/) with (//!.. and /*!..*/)

• Move comments to ’correct’ places; must lie exactly in front of or exactly after the code to comment. If after, comment delimiters must be //!<.. and /*!<..*/

• Don’t use ”the following two classes…”. Instead use a comment block for each class.