Browse Source

more md cleanups for printable docs

abakobo 8 years ago
parent
commit
e9406b1d6b

+ 7 - 0
modules/monkey/docs/language/misc.md

@@ -10,3 +10,10 @@ Hexadecimal numbers can be entered using the $ symbol
 ```
 Local i:=$A0F
 ```
+
+#### Inline Code comments
+
+Inline comments can be done with the `'` character.
+```
+Print "hello!" 'this line prints hello on the output console
+```

+ 1 - 2
modules/monkey/docs/language/preprocessor.md

@@ -10,7 +10,7 @@ Preprocessor expressions may only use the 'And', 'Or' and comparison operators.
 The following symbols may be used in preprocessor expressions:
 
 | Symbol			| Type		| Meaning
-|:------------------|:----------|--------
+|:----------------------|:------|:--------------------------------------------:
 | \_\_TARGET\_\_			| String	| The current build target. One of: "windows", "macos", "linux", "android", "ios", "emscripten"
 | \_\_CONFIG\_\_			| String	| The current build config. One of: "release", "debug"
 | \_\_DESKTOP\_TARGET\_\_	| Bool		| True if the current build target is windows, macos or linux.
@@ -34,4 +34,3 @@ To include code on desktop or mobile builds, use:
 Print "This code is only include in desktop and mobile builds."
 #Endif
 ```
-

+ 1 - 4
modules/monkey/docs/language/user-types.md

@@ -211,19 +211,17 @@ There are three Levels of encapsulation for class and struct members:
 
 -`Protected` members can only be accessed by the base class and the derived ones or by class/struct extensions. Code existing in the same source file have acces to `Protected` members too.
 
-`Private` members can only be accessed by the base class. Code existing in the same source file have acces to `Private` members too.
+-`Private` members can only be accessed by the base class. Code existing in the same source file have acces to `Private` members too.
 
 example:
 ```
 Class Foo
-
 	'public by default'
 	Field i:Int
 
 	Protected
 
 	Field someProtectedThing:Int
-
 	Method doSomething()
 		Print "Doing something"
 	End
@@ -231,6 +229,5 @@ Class Foo
 	Private
 
 	Field _somePrivateThing:String
-
 End
 ```

BIN
modules/monkey/docs/printableDocs.docx


+ 9 - 6
modules/monkey/docs/printableDocs.md

@@ -1247,19 +1247,17 @@ There are three Levels of encapsulation for class and struct members:
 
 -`Protected` members can only be accessed by the base class and the derived ones or by class/struct extensions. Code existing in the same source file have acces to `Protected` members too.
 
-`Private` members can only be accessed by the base class. Code existing in the same source file have acces to `Private` members too.
+-`Private` members can only be accessed by the base class. Code existing in the same source file have acces to `Private` members too.
 
 example:
 ```
 Class Foo
-
 	'public by default'
 	Field i:Int
 
 	Protected
 
 	Field someProtectedThing:Int
-
 	Method doSomething()
 		Print "Doing something"
 	End
@@ -1267,7 +1265,6 @@ Class Foo
 	Private
 
 	Field _somePrivateThing:String
-
 End
 ```
 
@@ -1282,7 +1279,7 @@ Preprocessor expressions may only use the 'And', 'Or' and comparison operators.
 The following symbols may be used in preprocessor expressions:
 
 | Symbol			| Type		| Meaning
-|:------------------|:----------|--------
+|:----------------------|:------|:--------------------------------------------:
 | \_\_TARGET\_\_			| String	| The current build target. One of: "windows", "macos", "linux", "android", "ios", "emscripten"
 | \_\_CONFIG\_\_			| String	| The current build config. One of: "release", "debug"
 | \_\_DESKTOP\_TARGET\_\_	| Bool		| True if the current build target is windows, macos or linux.
@@ -1307,7 +1304,6 @@ Print "This code is only include in desktop and mobile builds."
 #Endif
 ```
 
-
 ### Reflection
 
 #### Typeof and TypeInfo
@@ -1676,6 +1672,13 @@ Hexadecimal numbers can be entered using the $ symbol
 Local i:=$A0F
 ```
 
+#### Inline Code comments
+
+Inline comments can be done with the `'` character.
+```
+Print "hello!" 'this line prints hello on the output console
+```
+
 # Articles and Tutorials
 
 ### Operator Overloading