The LumiCode Project

Your content selections, diagrams, and reports are all saved in the project. LumiCode projects are self contained, so the assemblies they document need not be present on the machine to be viewed. This is valuable because a set of documentation can be distributed and viewed without distributing assemblies.

Starting a new project

1. Under the File menu, click New Project to begin.

Editing the project contents

1. When you create a new project, the Project Editor will open automatically.

2. Click the Add button and navigate to the folder where your assemblies are located.

3. Select the assemblies you want in your project, and then click Open. Then click OK to close the Project Editor.

Because .NET resolves references by looking in the current directory, all assembles chosen should be from the same directory.

Saving a project

1. Under the File menu, click Save Project. All your diagram, reports, and project assembly entries will be saved.

Refreshing a project

1. Under the Project menu, click Refresh.

When you open a new project, LumiCode takes a snapshot of the assemblies you have chosen.  You can save your project and reopen it and you will still be working from the same snapshot.

Refreshing the project will take a new snapshot that will reflect changes you have made to your code since the last snapshot.

External entities

When you use the Auto Select Bar, classes and methods that are not in your project may be added to your diagram. For example: your class may inherit from a system class, or your method may call a system method. These external entities will be on your diagram, but they are different in two ways:

1. They will not be on the class tree or method tree, so the only way to remove them is by selecting them and using the delete key on your keyboard.

2. There is less information available about them, so you cannot add the methods and fields for a class, or the parameters and return value for a method.