Documentation 0.35

Author: some-avail

README.md

@@ -4,19 +4,20 @@
 
 [See below for more screenshots](#more-screenshots)
 
-[Go to downloadable releases - forthcoming](https://github.com/some-avail/codetwig/releases "Downloads for CodeTwig")
+[Go to downloadable releases](https://github.com/some-avail/codetwig/releases "Downloads for CodeTwig")
 
 [Go to the user-manual](mostfiles/manual_codetwig.txt)
 
 
+#### Forthcoming version: 0.35
 
-#### Description CodeTwig
+### Description CodeTwig
 
 CodeTwig is terminal-program to view the outline of the source-code and to show procedures as usage-trees or used-by-trees. Allthough the tree-function is working quite well, the program is still young. See future-plans below.
 Currently only meant for Nim.
 
 
-#### Installation by building
+### Installation by building
 Since the program (at this stage) is for Nim only, users = programmers are assumed to be able to build the executable themselves.
 Developers can download a release, or clone the code 
 (CodeTwig has no external components) and do the following:
@@ -26,7 +27,7 @@ nim c -d:release ctwig.nim
 which will compile the code to an executable for you local OS.
 
 
-#### Using CodeTwig
+### Using CodeTwig
 [Go to the user-manual](mostfiles/manual_codetwig.txt)
 
 
@@ -35,18 +36,24 @@ which will compile the code to an executable for you local OS.
 Or look at the commits.
 [Commits-list](https://github.com/some-avail/codetwig/commits/main)
 
+See below for main step stones.
 
 
-#### Future plans:
-- Both in the views and in the tree-function the following information will be added:
+#### Completed from future plans
+-  ct 0.35 - Both in the views and in the tree-function the following information will be added:
   - procedural arguments
   - initial comments
+
+
+### Future plans:
 - better automatic source-file-selection
   - check multiple dir-levels
   - filter out backups, copies and older versions of source-files.
+- add a project-field so that multiple projects can be added to one declaration-list to enable multi-project search.
+- add a dec-view option (like the tree-view, but show full code)
 - add an options-file.
 
 
-
 <a name="more-screenshots">More screenshots:</a>
-Forthcoming.
+Forthcoming.
+

mostfiles/manual_codetwig.txt

@@ -51,6 +51,8 @@ ctwig projects/yourproject.pro -c:d
 Running this command will create a list of declarations. Declarations are the various procs, template, macros and functions. The file is not very readable, but will be used to create addtional views. Also it is parsed to generate the proc-trees on the fly. (see later). The list contains:
 - declarations (like procs) for all source-files
 - declarations that are used in above declarations (these are appended to above line)
+
+The arise of the dec-list happens in three phases, whereby phase 3 is the version that is used by other functions.
 ---------------------------------------------------------------------------
 
 -c:v or --command:views
@@ -59,7 +61,13 @@ no options
 Full example:
 ctwig projects/yourproject.pro -c:v
 
-Running this command will create some views of the source-code. Currently four views are available, basic and extended view with one level or two levels. The one-level-files show the source-files and the declarations only (usually mostly procs), and the two-level-files shows the usages of each declaration (used procs). The extended provide also the paramaters of function and the added comment.
+Running this command will create some views of the source-code. Currently four views are available, basic and extended view with one level or two levels. The one-level-files show the source-files and the declarations only (usually mostly procs), and the two-level-files shows the (first-level) usages of each declaration (used procs). The extended ones provide also the parameters of function and the added comment.
+
+So you get:
+yourproject_basic_one-level_view.txt
+yourproject_basic_two-level_view.txt
+yourproject_extended_one-level_view.txt
+yourproject_extended_two-level_view.txt
 ---------------------------------------------------------------------------
 
 -c:g or --command:generate_all
@@ -68,25 +76,30 @@ no options
 Full example:
 ctwig projects/yourproject.pro -c:g
 
-This command generates both the declaration-list and all of the views. Us it if you want tu update your project and are not interested in the output screen-notification.
+This command generates both the declaration-list and all of the views. Use it if you want to update your project and are not interested in the output screen-notification.
 ---------------------------------------------------------------------------
 
 -c:t or --command:tree
 options:
 * direction
--r:u or --direction:usage
+-r:u or --direction:usage    (default)
 -r:b or --direction:used-by
 * depth
--d:3 --depth:3
+-d:3 --depth:3   (default)
 
 Full examples:
 ctwig projects/yourproject.pro -c:t -r:b -d:4
 ctwig projects/yourproject.pro -c:t -r:u -d:2
+ctwig projects/yourproject.pro -c:t          (using the defaults)
 
 Seps can be ommitted:
 ctwig projects/yourproject.pro -ct -ru -d2
 
-Lastly above command starts with a box in which a substring can be entered to search for a declaration. Then  a list of declarations is displayed which have the substring in them. If the entered substring matches only one declaration, a tree is shown based on the parameters direction and depth. The direction usage refers to the calls to other procs that are made in the proc, where used-by stands for all the procs that are using the declaration (so the reverse process). The depths stands for the number of levels that are shown.
 
+Lastly above command starts with a box in which a substring can be entered to search for a declaration. Then  a list of declarations is displayed which have the substring in them. If the entered substring matches only one declaration, a tree is shown based on the parameters direction and depth. The direction usage refers to the calls to other procs that are made in the proc, where used-by stands for all the procs that are using the declaration (so the reverse process). The depths stands for the number of levels that are shown.
 
+As off CT 0.35 you can add a semi-column to indicate not only declaration but module as well, like so: 
+declaration;module
+This is needed to show same-named decs.
 
+Also now declarational arguments and comment are added to the chosen declaration.