external code snippets documentation update
@@ -11,10 +11,17 @@ Include-dash family is our custom extension to markdown to support various scena
File will be looked up using following rules:
* directory with a markup file
* root directory of a documentation
-* class path
+* all lookup paths listed in a special file
# Inline Comments
+Examples contain useful comments. Instead of copy and pasting them to the documentation we can extract them and make part
+of the text itself
+
+:include-file: simple.cpp
+
+Comments block in between blocks treated as markdown and rendered below
+
:include-cpp: simple.cpp {entry: "main", comments: "inline", bodyOnly: true}
# Callout Comments
@@ -22,5 +29,16 @@ File will be looked up using following rules:
If you already have comments inside your code it would be non effecient to repeat them inside documentation.
Instead comments can be automatically extracted and presented as part of the text
-:include-file: file-name-with-comments.js {lang: "javascript", commentsType: "inline"}
+Given file with inlined comments
+
+:include-file: file-name-with-comments.js
+
+By specifying `commentsType`
+
+ :include-file: file-name-with-comments.js {commentsType: "inline"}
+
+It will be rendered as
+
+:include-file: file-name-with-comments.js {commentsType: "inline"}
+
