1
- Format: 2.0 (Development Release 08-22-2015)
1
+ Format: 2.0.2
2
2
3
3
# This is the file you use to provide information about your project. It can
4
4
# also be used to specify input and output settings so you don't have to
@@ -29,10 +29,12 @@ Timestamp: Updated mm/dd/yyyy
29
29
# This is where you specify general information about your project.
30
30
#
31
31
# Style: [style]
32
- # The style to apply to the generated output.
32
+ # The style to apply to the generated documentation. It can be the name of
33
+ # a CSS file in the project configuration folder or a subfolder that
34
+ # contains Style.txt. Do not include ".css" if using a CSS file.
33
35
34
36
35
- # Input
37
+ # Source Code
36
38
# ------------------------------------------------------------------------
37
39
38
40
Source Folder: ..\..\..\MSCL\source\mscl
@@ -43,39 +45,40 @@ Source Folder: ..\..\..\MSCL\source\mscl
43
45
# scanning. If you use any of these options on the command line, this entire
44
46
# section is ignored except for names and numbers.
45
47
#
46
- # All paths are relative to the project folder, which lets this file remain
47
- # portable across computers and not cause problems in version control systems.
48
- # You can enter absolute paths and they will be converted automatically.
48
+ # All paths are relative to the project configuration folder, which lets this
49
+ # file remain portable across computers and not cause problems in version
50
+ # control systems. You can enter absolute paths and they will be converted
51
+ # automatically.
49
52
#
50
53
# Source Folder: [path]
51
54
# Name: [name]
52
55
#
53
56
# Specifies a folder which will be searched for source files. If you have
54
57
# more than one, add the Name property to set how it will show up in the
55
58
# menu.
56
- #
57
- # Image Folder: [path]
58
- # Specifies a folder which will be searched for image files.
59
59
60
60
61
- # Filtering
61
+ # Source Filtering
62
62
# ------------------------------------------------------------------------
63
63
64
- # If there are any subfolders of the input folders that you would like Natural
64
+ # If there are any subfolders in the source code that you would like Natural
65
65
# Docs to ignore, they can be specified here. If you use any of these options
66
66
# on the command line, this entire section is ignored.
67
67
#
68
68
# Ignore Source Folder: [path]
69
69
# Tells Natural Docs to skip this folder when scanning files.
70
70
#
71
71
# Ignore Source Folder Pattern: [pattern]
72
- # Tells Natural Docs to skip all folders which match this pattern when
72
+ # Tells Natural Docs to skip all folder names which match this pattern when
73
73
# scanning files. ? matches a single character, * matches zero or more
74
74
# characters. It applies to the entire folder name, so "cli" will not
75
75
# match "client", although "cli*" will.
76
+ #
77
+ # The data folders of common version control systems (.git, .svn, .cvs, .hg)
78
+ # are ignored automatically. You do not have to specify them here.
76
79
77
80
78
- # Output
81
+ # Generated Documentation
79
82
# ------------------------------------------------------------------------
80
83
81
84
HTML Output Folder: ..\..\..\Output\Documentation\MSCL_API_Docs
@@ -85,9 +88,10 @@ HTML Output Folder: ..\..\..\Output\Documentation\MSCL_API_Docs
85
88
# to build and where it should be put. If you use any of these options on the
86
89
# command line, this entire section is ignored except for secondary settings.
87
90
#
88
- # All paths are relative to the project folder, which lets this file remain
89
- # portable across computers and not cause problems in version control systems.
90
- # You can enter absolute paths and they will be converted automatically.
91
+ # All paths are relative to the project configuration folder, which lets this
92
+ # file remain portable across computers and not cause problems in version
93
+ # control systems. You can enter absolute paths and they will be converted
94
+ # automatically.
91
95
#
92
96
# You can override any of the project information settings under each entry,
93
97
# so if you have multiple output folders you can give them each different
0 commit comments