Skip to content

Commit 8388e97

Browse files
author
Rob Fisher
committed
Public release MSCL 62.1.2
1 parent 9648a78 commit 8388e97

File tree

82 files changed

+8537
-8281
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+8537
-8281
lines changed

BuildScripts/NaturalDocsProjects/MSCL_API_Docs_Project/Topics.txt renamed to BuildScripts/NaturalDocsProjects/MSCL_API_Docs_Project/Comments.txt

Lines changed: 102 additions & 112 deletions
Large diffs are not rendered by default.

BuildScripts/NaturalDocsProjects/MSCL_API_Docs_Project/Languages.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Format: 2.0 (Development Release 05-04-2015)
1+
Format: 2.0.2
22

33
# This is the Natural Docs languages file for this project. If you change
44
# anything here, it will apply to THIS PROJECT ONLY. You can edit the version
@@ -54,8 +54,8 @@
5454
#
5555
# Aliases: [alias] [alias] ...
5656
# [Add/Replace] Aliases: [alias] [alias] ...
57-
# Defines alternate names for the language that can be used in code block
58-
# tags like (start c++ code).
57+
# Defines alternate names for the language that can be used to start a code
58+
# block.
5959
#
6060
#
6161
# Properties for Basic Language Support Only
@@ -89,7 +89,7 @@
8989
# Defines whether the language's identifiers are case sensitive. The
9090
# default is yes.
9191
#
92-
# [Topic Type] Prototype Enders: [symbol] [symbol] ...
92+
# [Comment Type] Prototype Enders: [symbol] [symbol] ...
9393
# When defined, Natural Docs will attempt to get a prototype from the code
94-
# immediately following the topic type. It stops when it reaches one of
94+
# immediately following the comment type. It stops when it reaches one of
9595
# these symbols. Use \n for line breaks.

BuildScripts/NaturalDocsProjects/MSCL_API_Docs_Project/Project.txt

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Format: 2.0 (Development Release 08-22-2015)
1+
Format: 2.0.2
22

33
# This is the file you use to provide information about your project. It can
44
# also be used to specify input and output settings so you don't have to
@@ -29,10 +29,12 @@ Timestamp: Updated mm/dd/yyyy
2929
# This is where you specify general information about your project.
3030
#
3131
# 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.
3335

3436

35-
# Input
37+
# Source Code
3638
# ------------------------------------------------------------------------
3739

3840
Source Folder: ..\..\..\MSCL\source\mscl
@@ -43,39 +45,40 @@ Source Folder: ..\..\..\MSCL\source\mscl
4345
# scanning. If you use any of these options on the command line, this entire
4446
# section is ignored except for names and numbers.
4547
#
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.
4952
#
5053
# Source Folder: [path]
5154
# Name: [name]
5255
#
5356
# Specifies a folder which will be searched for source files. If you have
5457
# more than one, add the Name property to set how it will show up in the
5558
# menu.
56-
#
57-
# Image Folder: [path]
58-
# Specifies a folder which will be searched for image files.
5959

6060

61-
# Filtering
61+
# Source Filtering
6262
# ------------------------------------------------------------------------
6363

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
6565
# Docs to ignore, they can be specified here. If you use any of these options
6666
# on the command line, this entire section is ignored.
6767
#
6868
# Ignore Source Folder: [path]
6969
# Tells Natural Docs to skip this folder when scanning files.
7070
#
7171
# 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
7373
# scanning files. ? matches a single character, * matches zero or more
7474
# characters. It applies to the entire folder name, so "cli" will not
7575
# 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.
7679

7780

78-
# Output
81+
# Generated Documentation
7982
# ------------------------------------------------------------------------
8083

8184
HTML Output Folder: ..\..\..\Output\Documentation\MSCL_API_Docs
@@ -85,9 +88,10 @@ HTML Output Folder: ..\..\..\Output\Documentation\MSCL_API_Docs
8588
# to build and where it should be put. If you use any of these options on the
8689
# command line, this entire section is ignored except for secondary settings.
8790
#
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.
9195
#
9296
# You can override any of the project information settings under each entry,
9397
# so if you have multiple output folders you can give them each different

BuildScripts/NaturalDocsProjects/MSCL_API_Docs_Project/msclDocsStyle/Style.txt

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Format: 2.0 (Development Release 08-22-2015)
1+
Format: 2.0.2
22

33
# This is a configuration file for a Natural Docs HTML output style.
44

@@ -13,11 +13,10 @@ Inherit: Default
1313
#
1414
# Inherit: [style]
1515
#
16-
# All of its settings will be applied before yours. You can inherit more than
17-
# one style.
16+
# All of its settings will be applied before yours. You can add this line
17+
# multiple times to inherit more than one style.
1818
#
19-
# If you're building your own style from scratch, do not inherit anything. If
20-
# you just want to make some changes to the default style, inherit Default.
19+
# If you just want to make some changes to the default style, inherit Default.
2120
# If you're building your own page design from scratch but want to keep the
2221
# default JavaScript functions, inherit DefaultJS. This will include the code
2322
# but not the CSS or images.
@@ -35,13 +34,15 @@ Link: msclDocsStyle.css
3534
# Frame Link: [file]
3635
# Content Link: [file]
3736
#
38-
# These files will be included the generated output via link or script tags.
39-
# If you do not specify a page type, it will be included in every page.
37+
# These files will be added to the generated output via link or script tags.
4038
#
41-
# While all files will be copied to the output folder automatically, they are
42-
# not linked automatically. Since JavaScript files can be loaded dynamically
43-
# and CSS files can be imported from other ones, you must explicitly link the
44-
# ones you want here.
39+
# You can limit them to just to the frame page, which handles the header,
40+
# footer, menu, and summary, or to content pages, which is the documentation
41+
# in the rightmost panel. If you do not specify a page type, they will be
42+
# linked to every page.
43+
#
44+
# All files will be copied to the output folder even if you don't link them,
45+
# but they will not be added to the pages automatically.
4546

4647

4748
# OnLoad
@@ -53,9 +54,12 @@ Link: msclDocsStyle.css
5354
# Frame OnLoad: [statement]
5455
# Content OnLoad: [statement]
5556
#
56-
# If you do not specify a page type, it will be called for every page.
57+
# You can limit it to just to the frame page, which handles the header,
58+
# footer, menu, and summary, or to content pages, which is the documentation
59+
# in the rightmost panel. If you do not specify a page type, it will be added
60+
# to every page.
5761
#
58-
# The OnLoad statement is confined to a single line. It's recommended that
59-
# you make your OnLoad code a function in a separate .js file, link that file
60-
# from here, and then call it from this statement rather than trying to cram
61-
# it on this line.
62+
# The OnLoad statement is limited to a single line. If you have a lot of code
63+
# it's recommended that you make it a function in a separate .js file, link
64+
# that file, and then call the function from this statement rather than trying
65+
# to cram it all on this line.

0 commit comments

Comments
 (0)