1. Wolfgang Scherer
  2. c-code-cleaner

Commits

Wolfgang Scherer  committed 47beeb9

README.txt: clarification of parser scope and package purpose.

  • Participants
  • Parent commits cce3b71
  • Branches default

Comments (0)

Files changed (1)

File README.txt

View file
  • Ignore whitespace
    :raw:
 
 ##################################################
-:rem:`|||:sec:|||`\ Code Cleaner
+:rem:`|||:sec:|||`\ C Code Cleaner
 ##################################################
 .. \||<-snap->|| skip
 
 :Author: `Wolfgang Scherer`_
 
 .. contents::
-.. \||<-snap->|| skip
+..
+    1  Code Parser
+    2  Scan Defines GUI
+      2.1  INSTALLATION
+    3  Scan Defines
+      3.1  INSTALLATION
+      3.2  USAGE
+      3.3  DEVELOPMENT/MODIFICATIONS
+    4  Switch File Generator
+      4.1  INSTALLATION
+      4.2  USAGE
+      4.3  DEVELOPMENT/MODIFICATIONS
+    5  Code Cleaner
+      5.1  INSTALLATION
+      5.2  USAGE
+      5.3  DEVELOPMENT/MODIFICATIONS \||<-snap->|| skip
 .. \||<-snap->|| include ^index-header.snip$
 
 ==================================================
 Code Parser
 ==================================================
 
-Currently, a C-code parser is implemented.
+Currently, a full C preprocessor parser is implemented.
+
+The purpose is to manage preprocessor symbols and to physically remove
+source code based on (non-)definition of preprocessor symbols.
 
 There is some documentation in doc/html and doc/pdf.