Software Overview

Here are some informations about using the software
Software Image
The Software can split in tree parts:
  1. Source File and Destination Directory selection
  2. Types and Details of the generation
  3. Generate the Pages

Source File and Destination Directory selection

Select the Source File (Assembly) for that the documentation should be generated.
Select the Destination Directory where the generated Pages should be save.
In the destination selection I have use the SaveFileDialog because WPF has no build-in DirectorySelectionDialog.
SelectDirDialog Image
Ignore the Save-Filename in the Dialog. I extract the directory and ignore the Filename in the Dialog.
Perheps I will change it in the feature.

Types and Details of the generation

When you have selected an Assembly-File the ListView will automatical fill with the ExportedTypes of the Assemlby.
Select the Type that you want to export to the documentation.
After that you can select the Pages that schould be generated.
  • Assembly Summary: A List of all selected Namespaces
  • Namespace Summary: A List of all selected Types in this Namespace
  • Type Summary: A List of all Member (Methods, Property, Field, Events) of the Type
  • Type Member Details: A Page for each Member (Methods, Property, Field, Events) of the Type

Generate the Pages

After all selection press the Convert-Button to start the generating of the documentation.
After that you find the Pages in the selected Directory.
You can open, edit and convert the pages in the Codeplex WikiFormat with the tool: Codeplex WikiEditor


This WikiPage was created with Codeplex WikiEditor

Last edited Jun 28, 2010 at 7:48 AM by SoftHai, version 2

Comments

No comments yet.