Sandcastle Help File Builder Documentation
Build
Methods
| Build | Call this method to perform the build on the project. |
| EnsureOutputFoldersExist | This is used to ensure that all output folders exist based on the selected help file format(s) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExecuteAfterStepPlugIns | This can be used by plug-ins using the InsteadOf execution behavior to execute plug-ins that want to run after the plug-in has executed its main processing. |
| ExecuteBeforeStepPlugIns | This can be used by plug-ins using the InsteadOf execution behavior to execute plug-ins that want to run before the plug-in executes its main processing. |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FindHtmlHelpCompiler | Find the HTML help compiler |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetReferencedNamespaces | This is used to get an enumerable list of unique namespaces from the given reflection data file |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ReportError | This is used to report an error that will abort the build |
| ReportProgress(String, Object) | This is used to report progress during the build process within the current step |
| ReportProgress(BuildStep, String, Object) | This is used to report progress during the build process and possibly update the current step |
| ReportWarning | This is used to report a warning that may need attention |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| VerifySafePath | Make sure the path isn't one the user would regret having nuked without warning |