Sometimes you may want to insert your own external files in your documentation, e.g. images, CSS files, your own HTML topic files, etc. You can create special folder where you place all those files. You specify this folder in VSdocman options. When VSdocman generates documentation, whole content of that folder is copied in the output folder and all files are also embedded in compiled CHM or Help2 documentation.

You can reference your external files directly in your XML comments using for example <see> or <img> tags. Since the files including all subfolders are copied in the output folder, you can use relative paths.

Example

Your folder for external files is c:\MyFiles. It contains one file myFile.html and subfolder subFolder with one file myPicture.png:

c:\MyFiles
     subFolder
          myPicture.png
     myFile.html

You can reference both files as follows:

'''<summary>Our sample property.</summary>
'''<remarks>Here is a link to <see

'''cref="^myFile.html">external file</see>.
'''Here we have picture <img cref="subFolder/myPicture.png" />
'''</remarks>
'''<seealso cref="^myFile.html">Interesting file</seealso>
Function method1(ByVal x As Integer) As Boolean

External files must be distributed together with documentation file as well, except for HTML Help (CHM) and Help 2 (HxS) formats. CHM and Help 2 formats contain all files packed in its file so you do not need to distribute them separately.

See Also

Adding Images in Documentation | <seealso> Tag | <see> Tag | <img> Tag