Kaynağa Gözat

[docs] Formatting.

woollybah 5 yıl önce
ebeveyn
işleme
bd177df9e2

+ 2 - 2
blitz.mod/blitz.bmx

@@ -586,7 +586,7 @@ End Interface
 Rem
 Rem
 bbdoc: Set strict mode
 bbdoc: Set strict mode
 about:
 about:
-See the <a href=../../../../doc/bmxlang/compatibility.html>BlitzMax Language Reference</a> for more information on Strict mode programming.
+See the <a href="../../../../doc/bmxlang/compatibility.html">BlitzMax Language Reference</a> for more information on Strict mode programming.
 keyword: "Strict"
 keyword: "Strict"
 End Rem
 End Rem
 
 
@@ -1020,7 +1020,7 @@ End Rem
 Rem
 Rem
 bbdoc: Declare module scope and identifier
 bbdoc: Declare module scope and identifier
 about:
 about:
-See the <a href=../../../../doc/bmxlang/modules.html>BlitzMax Language Reference</a> for more information on BlitzMax Modules.
+See the <a href="../../../../doc/bmxlang/modules.html">BlitzMax Language Reference</a> for more information on BlitzMax Modules.
 keyword: "Module"
 keyword: "Module"
 End Rem
 End Rem
 
 

+ 15 - 15
maxunit.mod/doc/intro.bbdoc

@@ -1,13 +1,13 @@
 <img src="logo.png" align="right" />
 <img src="logo.png" align="right" />
 <p>A unit testing Module based loosely on JUnit.</p>
 <p>A unit testing Module based loosely on JUnit.</p>
-To define a test :<br>
+To define a test :<br/>
 <ol>
 <ol>
 <li> implement a sub-Type of TTest</li>
 <li> implement a sub-Type of TTest</li>
-<li> initialize the user states by creating a Method tagged with {before}</li>
-<li> clean-up after a test by creating a Method tagged with {after}.</li>
+<li> initialize the user states by creating a Method tagged with `{before}`</li>
+<li> clean-up after a test by creating a Method tagged with `{after}`.</li>
 </ol>
 </ol>
 Here is an example:
 Here is an example:
-<pre>
+```blitzmax
 Type MyTest Extends TTest
 Type MyTest Extends TTest
 
 
 	Local value1:Int
 	Local value1:Int
@@ -19,24 +19,24 @@ Type MyTest Extends TTest
 	End Method
 	End Method
 
 
 End Type
 End Type
-</pre>
+```
 For each test implement a @Method which interacts with the fixture. You tell MaxUnit that this is a test Method by
 For each test implement a @Method which interacts with the fixture. You tell MaxUnit that this is a test Method by
 tagging it with {test}. The Method can otherwise be called anything you like. It should take no parameters and not
 tagging it with {test}. The Method can otherwise be called anything you like. It should take no parameters and not
-return anything.<br>
+return anything.<br/>
 Verify the expected results with assertions specified by calling @assertTrue with a boolean.
 Verify the expected results with assertions specified by calling @assertTrue with a boolean.
-<pre>
+```blitzmax
 	Method testAdd() { test }
 	Method testAdd() { test }
 		Local result:Int = value1 + value2
 		Local result:Int = value1 + value2
 		assertTrue(result = 5)
 		assertTrue(result = 5)
 	End Method
 	End Method
-</pre>
+```
 Finally, you can run the tests by creating an instance of the TTestSuite and calling its @run method.
 Finally, you can run the tests by creating an instance of the TTestSuite and calling its @run method.
-<pre>
+```blitzmax
 New TTestSuite.run()
 New TTestSuite.run()
-</pre>
-The following code snippet is a complete example, including a failed test :<br>
+```
+The following code snippet is a complete example, including a failed test :<br/>
 You can open the source <a href="example.bmx">here</a>.
 You can open the source <a href="example.bmx">here</a>.
-<pre>
+```blitzmax
 SuperStrict
 SuperStrict
 
 
 Import BRL.MaxUnit
 Import BRL.MaxUnit
@@ -69,9 +69,9 @@ Type MyTest Extends TTest
 	End Method
 	End Method
 
 
 End Type
 End Type
-</pre>
+```
 The above program should produce the following output :
 The above program should produce the following output :
-<pre>
+```
 [0] ..F
 [0] ..F
 
 
 There was 1 failure:
 There was 1 failure:
@@ -84,4 +84,4 @@ Tests run: 3,  Failures: 1,  Errors: 0
 Time: 0.0
 Time: 0.0
 
 
 Process complete
 Process complete
-</pre>
+```

+ 3 - 3
maxunit.mod/maxunit.bmx

@@ -59,13 +59,13 @@ Rem
 bbdoc: A test defines a set of test methods to test.
 bbdoc: A test defines a set of test methods to test.
 about: Extend TTest to define your own tests.
 about: Extend TTest to define your own tests.
 <p>
 <p>
-Tag a method with {before} and initiliaze any variables/data in that method
+Tag a method with `{before}` and initiliaze any variables/data in that method
 </p>
 </p>
 <p>
 <p>
-Tag a method with {after} to release any permanent resources you allocated in the setup.
+Tag a method with `{after}` to release any permanent resources you allocated in the setup.
 </p>
 </p>
 <p>
 <p>
-For each test method you want to run, tag it with {test}
+For each test method you want to run, tag it with `{test}`
 </p>
 </p>
 <p>
 <p>
 Any methods not tagged are ignored by MaxUnit.
 Any methods not tagged are ignored by MaxUnit.

+ 1 - 1
pixmap.mod/pixmap.bmx

@@ -264,7 +264,7 @@ bbdoc: Abstract base type for pixmap loaders
 about:
 about:
 To create a new pixmap loader, you should extend TPixmapLoader and implement the #LoadPixmap method.
 To create a new pixmap loader, you should extend TPixmapLoader and implement the #LoadPixmap method.
 
 
-To install your pixmap loader, simply create an instance of it using #New</font>.
+To install your pixmap loader, simply create an instance of it using #New.
 End Rem
 End Rem
 Type TPixmapLoader
 Type TPixmapLoader
 	Field _succ:TPixmapLoader
 	Field _succ:TPixmapLoader

+ 2 - 2
random.mod/doc/intro.bbdoc

@@ -5,7 +5,7 @@ The numbers generated are not really random, as without special hardware support
 Instead, the algorithm produces values that merely appear to be random. In reality, each generated value actually depends on the previously generated value.
 Instead, the algorithm produces values that merely appear to be random. In reality, each generated value actually depends on the previously generated value.
 
 
 You can set the 'state' of the random number generator using the #SeedRnd command. A common practice is to seed the random number generator with the system time when your program starts up, for example:
 You can set the 'state' of the random number generator using the #SeedRnd command. A common practice is to seed the random number generator with the system time when your program starts up, for example:
-{{
+```blitzmax
 SeedRnd MilliSecs()
 SeedRnd MilliSecs()
-}}
+```
 This ensures that the random number generator does not start in the same state each time your program is run, which would cause it to produce the same sequence of random numbers.
 This ensures that the random number generator does not start in the same state each time your program is run, which would cause it to produce the same sequence of random numbers.