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. The Nachos documentation was developed
by using Doxygen.

• 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.

This section will help you learn how to locate specific parts of this Nachos HTML reference package and how to browse it in 
an efficent way. Below you will see several assignments which you ought to do before getting started with the lab assignments:

      1.a: Name three of the Semaphore class methods.
         b: Pick one of the methods in 1.a and tell where it is located (what Nachos source file?).
      2.a: The variable inHdr belongs to a class, which one?
         b: Is this variable private or public?
         c: What information does it contain?
      3:    What does the class SynchList define?
      4.a: What functions refers to the IsHeldByCurrentThread method of the Lock class?
         b: How many classes has a method called Initialize?

It is pretty hard to get the total picture over Nachos at the begining, therefore it is good if you get into this HTML package. It 
will really pay off!

It is possible to extend this package. This would be a good idea, both for your Doxygen knowledge and for understanding Nachos.
To extend this package after including your own documentation in Nachos, check out the Doxygen home page.
 

Commenting Nachos for Doxygen

• 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.

Together with this documentation, you will find a Nachos Beginner's Guide that will help getting started with Nachos.