docs: #377 create documentation

- added documentation per package module

- included information about the code, how to build and run it

- give information about the flags that can be used

Author: miguelcsx

rust-code-analysis-cli/README.md

@@ -0,0 +1,71 @@
+# rust-code-analysis-cli
+
+`rust-code-analysis-cli` is a tool designed to compute and export code metrics, analyze source code, and perform various operations such as removing comments, counting nodes, retrieving functions, and computing code metrics in different formats.
+
+## Features
+
+- Analyze source code for different programming languages.
+- Export results in different formats (CBOR, JSON, TOML, YAML).
+- Perform various operations on source code (e.g., dumping abstract syntax tree to stdout, count nodes, computing code metrics).
+
+## Project Structure
+
+```sh
+rust-code-analysis-cli
+├── Cargo.toml      # Project metadata and dependencies
+└── src
+    ├── formats.rs  # Handles format-specific output (CBOR, JSON, TOML, YAML)
+    └── main.rs     # Main logic for command-line operations and code analysis
+```
+
+## Installation
+
+To use this tool, you need to have Rust installed on your system.
+
+Clone the repository and run the following command:
+
+```sh
+cd rust-code-analysis-cli/
+cargo build --debug # or cargo build --release
+```
+
+## Usage
+
+Run the tool by specifying the input file and the desired operation:
+
+```sh
+cargo run -- [OPTIONS]
+```
+
+## Available Options
+
+- `-p, --paths <FILE>...`: Input files to analyze.
+- `-d, --dump`: Dump the abstract syntax tree to stdout.
+- `-c, --comments`: Remove comments from specified files.
+- `-f, --find <NODE_TYPE>`: Find nodes of the given type.
+- `-F, --function`: Get functions and their spans.
+- `-C, --count <NODE_TYPE>`: Count nodes of the given type.
+- `-m, --metrics`: Compute code metrics.
+- `--ops`: Retrieve all operands and operators in the code.
+- `-i, --in-place`: Do actions in place.
+- `-I, --include [<INCLUDE>...]`: Include files matching the given pattern.
+- `-X, --exclude [<EXCLUDE>...]`: Exclude files matching the given pattern.
+- `-j, --num-jobs <NUM_JOBS>`: Number of threads to use.
+- `-l, --language-type <LANGUAGE>`: Language of the input files.
+- `-O, --output-format <FORMAT>`: Output format for the results (CBOR, JSON, TOML, YAML).
+- `--pr`: Dump a pretty json output file.
+- `-o, --output <OUTPUT>`: Output directory for the results.
+- `--preproc <PREPROCESSOR>`: Get preprocessor directives for C/C++ files.
+- `--ls <LINE_START>`: Start line for the analysis.
+- `--le <LINE_END>`: End line for the analysis.
+- `-w, --warning`: Show warnings.
+- `-v, --version`: Show version information.
+- `-h, --help`: Show help information.
+
+## Examples
+
+To analyze the code in a file and export the metrics in JSON format:
+
+```sh
+cargo run -- --metrics --output-format json --output . --paths path/to/file.rs
+```

rust-code-analysis-web/README.md

@@ -0,0 +1,61 @@
+# rust-code-analysis-web
+
+`rust-code-analysis-web` is a web server that facilitates the analysis of source code through a RESTful API. It is part of the rust-code-analysis suite and allows developers to remotely interact with the code analysis features provided by the library.
+
+## Features
+
+- **Comment Removal**: Removes comments from source code to produce a clean version.
+- **Function Spans**: Retrieves the start and end lines of functions in the provided source code.
+- **Metrics Calculation**: Computes various static analysis metrics for the source code.
+
+## Project Structure
+
+```sh
+rust-code-analysis-web
+├── Cargo.toml      # Project metadata, dependencies, and build configuration
+└── src
+    ├── bin/
+    │   └── rust-code-analysis-web.rs  # Entry point for running the web server with CLI options
+    ├── web/
+    │   ├── comment.rs    # Logic for handling requests related to removing comments from source code
+    │   ├── function.rs   # Logic for extracting and returning function spans from the source code
+    │   ├── metrics.rs    # Logic for computing and returning code metrics based on the source code
+    │   ├── mod.rs        # Module declarations and routing between web modules
+    │   └── server.rs     # Actix web server setup, route definitions, and main server handler logic
+    └── lib.rs            # Main library file, sets up the module imports and starts the server
+```
+
+## Installation
+
+To use `rust-code-analysis-web`, you need to have Rust installed on your system.
+
+Clone the repository and run the following command:
+
+```sh
+cd rust-code-analysis-web/
+cargo build --debug # or cargo build --release
+```
+
+## Usage
+
+Run the server by specifying the host and port:
+
+```sh
+cargo run -- [OPTIONS]
+```
+
+### Available Options
+
+- `-j, --num-jobs <NUM_JOBS>`: Number of parallel jobs to run (optional).
+- `--host <HOST>`: IP address where the server should run (default is 127.0.0.1).
+- `--port <PORT>`: Port to be used by the server (default is 8080).
+- `-h, --help`: Show help information.
+- `-v, --version`: Show version information.
+
+# Examples
+
+To start the server on a specific host and port:
+
+```sh
+cargo run -- --host <HOST> --port <PORT> -j <NUM_JOBS>
+```