Skip to content

Commit 0572fed

Browse files
committed
update a number of pages, fix backslashed underscores
1 parent a917df6 commit 0572fed

16 files changed

+208
-314
lines changed

_docs/Attributes_in_fedex_plus.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
2+
layout: docs
3+
permalink:
24
title: Attributes in fedex plus
35
---
46

57
This comes from
6-
[classes\_misc.c:709](https://github.com/stepcode/stepcode/blob/master/src/fedex_plus/classes_misc.c#L709).
8+
[classes_misc.c:709](https://github.com/stepcode/stepcode/blob/master/src/fedex_plus/classes_misc.c#L709).
79
It should be formatted such that doxygen sees it.
810

911
Attributes are divided into four categories: these are not exclusive as
@@ -12,11 +14,11 @@ far as I can tell! I added defs below DAS
1214
- simple explicit
1315
- type shifters
1416
- not DERIVEd - redefines type in ancestor
15-
- VARget\_initializer(v) returns null
17+
- VARget_initializer(v) returns null
1618

1719
- simple derived
18-
- DERIVEd - is calculated - VARget\_initializer(v)
19-
- returns non-zero, VARis\_derived(v) is non-zero
20+
- DERIVEd - is calculated - VARget_initializer(v)
21+
- returns non-zero, VARis_derived(v) is non-zero
2022

2123
- overriding
2224
- includes type shifters and derived

_docs/BRL-CAD_patches.md

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

_docs/Code_analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Cross Platform
1010
ctest/cdash (testing)
1111
---------------------
1212

13-
- install cmake/ctest, then run 'ctest -S run\_ctest.cmake'
13+
- install cmake/ctest, then run 'ctest -S run_ctest.cmake'
1414
- test submission to my.ctest.org requires creation of a file in the
1515
dir above the STEPcode source; read the messages from the above
1616
command

_docs/Files_and_directories.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,21 @@ application that wants to read or write STEP data.
3333

3434
#### Tools
3535

36-
The tools are fedex\_plus, fedex\_python, check\_express, and exppp.
36+
The tools are fedex_plus, fedex_python, check_express, and exppp.
3737

38-
- **check\_express** uses libexpress (below) to check an EXPRESS
38+
- **check_express** uses libexpress (below) to check an EXPRESS
3939
schema for errors. Formerly named **express**, it is the simplest
4040
possible use of libexpress.
41-
- **fedex\_plus** parses an EXPRESS schema using libexpress, analyzes
41+
- **fedex_plus** parses an EXPRESS schema using libexpress, analyzes
4242
the in-memory representation of the EXPRESS, and writes
4343
schema-specific C++ source code that is the compiled into one of the
4444
aforementioned schema-specific libraries.
45-
- **fedex\_python** is a work in progress. It is similar to
46-
fedex\_plus but writes Python code instead.
45+
- **fedex_python** is a work in progress. It is similar to
46+
fedex_plus but writes Python code instead.
4747
- **exppp**, the EXPRESS Pretty Printer, formats EXPRESS in a way that
4848
is easy to read. The executable is currently not built because it is
4949
rarely used, but the library is still built and is used by
50-
fedex\_plus and fedex\_python.
50+
fedex_plus and fedex_python.
5151

5252
#### Other libraries
5353

@@ -60,7 +60,7 @@ also used at runtime~~, along with a few hashing functions in
6060
implementations of malloc, calloc, realloc, free, new, and delete
6161
that warn of improper use and record the file and line number.
6262
- **libexppp** formats EXPRESS so that it is easy to read. It is used
63-
to format some things that fedex\_plus and fedex\_python do not
63+
to format some things that fedex_plus and fedex_python do not
6464
currently translate into C++ or Python, such as FUNCTIONs and RULEs.
6565
- **libexpress** parses an EXPRESS schema in a file and builds a model
6666
of the schema in memory.
Lines changed: 25 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,50 @@
11
---
2+
layout: docs
3+
permalink: /docs/usage2/
24
title: How to use STEPcode in an application
35
---
46

5-
CMake Integration
6-
-----------------
7+
## CMake Integration
78

8-
- Use **SC\_IS\_SUBBUILD** and **SC\_BUILD\_SCHEMAS**
9-
- **SC\_SDAI\_ADDITIONAL\_EXES\_SRCS** can be used to have SC build
9+
- Use **SC_IS_SUBBUILD** and **SC_BUILD_SCHEMAS**
10+
- **SC_SDAI_ADDITIONAL_EXES_SRCS** can be used to have SC build
1011
single-file executables (similar to p21read)
1112
- this will not work for applications with more than one source
1213
code file or that need to link other libs.
1314

14-
#### See also: [STEPcode CMake variables](STEPcode_CMake_variables.html)
15+
#### See also: [CMake variables used by STEPcode](/docs/cmake_vars/)
1516

16-
C++ examples
17-
------------
17+
## C++ examples
1818

19-
- [Minimal Part 21 C++
20-
example](Minimal_Part_21_C++_example.html)
21-
- doxygen documentation of [apps using
22-
STEPcode](http://stepcode.org/stepcode-use-doxygen/)
19+
- [Minimal Part 21 C++ example](Minimal_Part_21_C++_example.html)
20+
- doxygen documentation of [apps using STEPcode](http://stepcode.org/stepcode-use-doxygen/)
2321
- [sc/src/express/test](https://github.com/stepcode/stepcode/tree/master/src/express/test/)
24-
- tests executables for the express parser
22+
- tests for the express parser
2523
- [sc/test/cpp/](http://github.com/stepcode/stepcode/tree/master/test/cpp/)
26-
- tests written in c++; these can be built when ENABLE\_TESTING is
27-
set to ON, but are excluded from 'make all'
24+
- tests written in c++; these can be built when ENABLE_TESTING is set to ON, but are excluded from 'make all'
2825
- [sc/src/test](http://github.com/stepcode/stepcode/tree/master/src/test)
29-
- tests written by NIST; all are up-to-date, but
30-
[p21read](https://github.com/stepcode/stepcode/blob/master/src/test/p21read/p21read.cc#L138)
31-
is the most frequently used. See the README in sc/src/test for more.
26+
- tests written by NIST; all are up-to-date, but [p21read](https://github.com/stepcode/stepcode/blob/master/src/test/p21read/p21read.cc#L138) is the most frequently used. See the README in sc/src/test for more.
3227
- [sc/src/clprobe-ui](http://github.com/stepcode/stepcode/tree/master/src/clprobe-ui)
33-
- remnants of a UI known as dataProbe; requires the
34-
[InterViews](http://www.ivtools.org/ivtools/interviews.html)
35-
toolkit, which predates X windows. An attempt has been made to
36-
resurrect it, but without success.
37-
- TODO: Example using lazy loading code. For now, see
38-
[lazy\_test.cc](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazy_test.cc)
39-
in the repo.
28+
- remnants of a UI known as dataProbe; requires the [InterViews](http://www.ivtools.org/ivtools/interviews.html) toolkit, which predates X windows. An attempt has been made to resurrect it, but without success.
29+
- TODO: Example using lazy loading code. For now, see [lazy_test.cc](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazy_test.cc) in the repo.
4030

41-
C++ applications that are not in the GitHub repository
42-
------------------------------------------------------
31+
## C++ applications that are not in the GitHub repository
4332

44-
The BRL-CAD
45-
[step-g](http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/src/conv/step/)
46-
converter, documented
47-
[here](http://stepcode.org/stepcode-use-doxygen/step-g_8cpp.html) (Note
48-
- currently, the BRL-CAD version of STEPcode differs slightly from the
49-
version on GitHub)
33+
The BRL-CAD [step-g](http://brlcad.svn.sourceforge.net/viewvc/brlcad/brlcad/trunk/src/conv/step/) converter, documented [here](http://stepcode.org/stepcode-use-doxygen/step-g_8cpp.html) (Note - currently, the BRL-CAD version of STEPcode differs slightly from the version on GitHub)
5034

5135
Laurent Bauer's [SCView](https://github.com/LaurentBauer/SCView/wiki)
5236

53-
Python
54-
------
37+
## Python
5538

56-
- [Python
57-
Generator](http://github.com/stepcode/stepcode/wiki/python-generator)
39+
- [Python Generator](http://github.com/stepcode/stepcode/wiki/python-generator)
5840

59-
TODO
60-
----
41+
## TODO
6142

62-
- describe use of [lazy loading
63-
code](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazyInstMgr.h)
64-
- create a page with a small Part 21 file, with description of format
65-
and links to relevant classes - SDAI\_Application\_instance,
66-
STEPcomplex, generated code (?)
67-
- run doxygen on parts of STEPcode (libexpress + exppp + fedex\_plus,
68-
fedex\_python, cllazyfile, cleditor, clstepcore + cldai + clutils +
69-
base ) **and automate doxygen with a script**
43+
- describe use of [lazy loading code](http://github.com/stepcode/stepcode/blob/master/src/cllazyfile/lazyInstMgr.h)
44+
- create a page with a small Part 21 file, with description of format and links to relevant classes - SDAI_Application_instance, STEPcomplex, generated code (?)
45+
- run doxygen on parts of STEPcode (libexpress + exppp + fedex_plus, fedex_python, cllazyfile, cleditor, clstepcore + cldai + clutils + base ) **and automate doxygen with a script**
7046

71-
See also
72-
--------
47+
## See also
7348

74-
- [Building STEPcode](Building_STEPcode.html)
75-
- [How to test with CTest](How_to_test_with_CTest.html)
76-
77-
[Category:Code discussion](Category:Code_discussion.html)
49+
- [Building STEPcode](/docs/building/)
50+
- [Testing](/docs/testing)

_docs/Libexpress_structs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ struct Statement_ {
7878
};
7979
`
8080

81-
### Case\_Statement
81+
### Case_Statement
8282

8383
`
8484
struct Case_Statement_ {
@@ -87,7 +87,7 @@ struct Case_Statement_ {
8787
};
8888
`
8989

90-
### Compound\_Statement
90+
### Compound_Statement
9191

9292
`
9393
struct Compound_Statement_ {
@@ -116,7 +116,7 @@ struct Loop_ {
116116
};
117117
`
118118

119-
### Procedure\_Call
119+
### Procedure_Call
120120

121121
`
122122
struct Procedure_Call_ {
@@ -125,7 +125,7 @@ struct Procedure_Call_ {
125125
};
126126
`
127127

128-
### Return\_Statement
128+
### Return_Statement
129129

130130
`
131131
struct Return_Statement_ {
@@ -281,7 +281,7 @@ struct Procedure_ {
281281
Others
282282
------
283283

284-
### Case\_Item
284+
### Case_Item
285285

286286
``
287287

@@ -352,7 +352,7 @@ struct Expression_ {
352352
};
353353
`
354354

355-
### Linked\_List
355+
### Linked_List
356356

357357
``
358358

_docs/List_of_projects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: List of projects
33
---
44

55
|---|
6-
|\_\_TOC\_\_|
6+
|__TOC__|
77

88
STEPcode is participating in GSoC again!
99
========================================

_docs/List_of_tasks.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
---
2+
layout: docs
3+
permalink:
24
title: List of tasks
35
---
46

57
On the wiki
68
-----------
79

8-
- Document the data structures in *libexpress*, *fedex\_plus*
10+
- Document the data structures in *libexpress*, *fedex_plus*
911
- Copy content from github wiki?
1012
- More external links
1113
- Logo, background

_docs/Minimal_Part_21_C++_example.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Important Classes
1515
file)
1616
- [STEPfile](http://stepcode.org/doxygen/class_s_t_e_pfile.html)
1717
(takes care of reading and writing Part 21 files, and creates an
18-
SDAI\_Application\_instance for every instance read)
19-
- [SDAI\_Application\_instance](http://stepcode.org/doxygen/class_s_d_a_i___application__instance.html)
18+
SDAI_Application_instance for every instance read)
19+
- [SDAI_Application_instance](http://stepcode.org/doxygen/class_s_d_a_i___application__instance.html)
2020
(the base class for every type of instance that STEP deals with)
2121

2222
Code
@@ -90,11 +90,11 @@ Linking
9090
Your executable will need to link to various libraries, likely including
9191
a generated library, specific to the schema you are interested in. Once
9292
generated, this lib can be found in build/lib with a prefix of
93-
libsdai\_.
93+
libsdai_.
9494

9595
It will also need to link with cldai, cleditor, clstepcore, and clutils - all found in build/lib.
9696

97-
If you get stuck, consider examining the compile/link commands used for one of the p21read executables. This can be done with **make VERBOSE=1\_**:
97+
If you get stuck, consider examining the compile/link commands used for one of the p21read executables. This can be done with **make VERBOSE=1_**:
9898

9999
`make VERBOSE=1 p21read_sdai_ap214e3`
100100

_docs/STEPcode.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@ title: Welcome
44
permalink: /docs/home/
55
---
66

7-
STEPcode • Data Exchange with the technologies of ISO 10303
8-
9-
# Welcome
107
----
118

129
The **STEPcode** project is a collection of open source libraries, tools, and resources that revolve around the technologies of [ISO 10303](http://en.wikipedia.org/w/index.php?title=ISO_10303), a.k.a. STEP, the **ST**andard for the **E**xchange of **P**roduct model data.
@@ -19,32 +16,21 @@ STEPcode provides a cross-platform (Linux, OSX, **and** Windows) implementation
1916
- a library that allows STEP Part 21 files to be read and written
2017
- various utilities, test routines, and test schemas
2118

22-
19+
2320
The [BSD license](http://github.com/stepcode/stepcode/blob/master/COPYING) allows commercial use. In addition, STEPcode is used in other open source projects such as [BRL-CAD](http://www.brl-cad.org) and [SCView](http://github.com/LaurentBauer/SCView).
24-
21+
2522
STEPcode traces its roots to the NIST STEP Class Library (SCL) which was developed between ~1987 and 1998.
2623

2724
See also: [History](History.html), [List of external resources](List_of_external_resources.html), [List of OSS or free STEP programs](List_of_OSS_or_free_STEP_programs.html)
2825

29-
### GSoC 2014
30-
31-
We're participating again!
32-
33-
See the [Checklist](http://brlcad.org/wiki/Summer_of_Code/Checklist) and the BRL-CAD [project ideas](http://brlcad.org/wiki/Google_Summer_of_Code/Project_Ideas). If those ideas don't interest you, you can also look at the longer [list of projects](List_of_projects.html) on this wiki.
34-
3526
### Quick Start
3627

37-
- See the [getting started](Getting_started.html) page
28+
- See the [basic usage](/docs/usage) page
3829

3930
### Communication
4031

41-
- **[STEPcode
42-
mailing list](https://groups.google.com/forum/#!forum/scl-dev)** on google groups (new users are moderated to
43-
discourage spam)
44-
- **#stepcode** on freenode - use an IRC client or [your
45-
browser](http://webchat.freenode.net/?channels=stepcode). There is
46-
also a [log](http://ibot.rikers.org/%23stepcode/) thanks to Tim
47-
Rikers.
32+
- **[STEPcode mailing list](https://groups.google.com/forum/#!forum/scl-dev)** on google groups (new users are moderated to discourage spam)
33+
- **#stepcode** on freenode - use an IRC client or [your browser](http://webchat.freenode.net/?channels=stepcode). There is also a [log](http://ibot.rikers.org/%23stepcode/) thanks to Tim Rikers.
4834

4935
STEP & Other Standards
5036
----------------------

0 commit comments

Comments
 (0)