When VSdocman is set properly, you can compile a new documentation for a whole solution.
Compiling to single documentation
Pressing Compile Solution to Single Documentation button in VSdocman dialog causes that every C#, VB or ASP project in the solution is compiled into a single resulting documentation. This kind of documentation is suitable if your projects share namespaces and you need one unified documentation for all of them. All members from the same namespace will be merged. Some essential compilation settings such as output format (template), output path, help title, custom topics and file naming format are taken from the solution-wide common properties. They will be applied to the entire documentation. Additionally, you can select other settings from the common properties that will override the settings from individual projects. VSdocman will prompt you before the compilation. You will probably want to use a single common footer text, syntax languages, etc. The list of the selected settings will be remembered when you compile next time or from a command line. |
Compiling to multiple documentations
Pressing Compile Projects in Solution Separately button in VSdocman dialog causes that every VB, C# or ASP project in the solution is compiled with its own settings into separate documentation. It acts exactly as thought you compiled them separately one-by-one. In addition to project documentation, VSdocman generates one master documentation in every project's output folder. Master documentation includes links to each project documentation in the solution and its name is Solution+. It doesn't physically contain each project's documentation. It only references them depending on the output format. So you can freely make changes to sub-documents without the need to change the master document. This is extremely useful in distributed team work. All sub documents are exactly the same as if generated for a single project. If you plan to use the master documentation, it is necessary that all projects be set to produce documentation of the same format (HxS, CHM, HTML or other). So you have several projects and each of them has its master document. You only need one of them because they are all the same, others can be deleted. Click here to learn how to view and deploy solution documentation. |