DocXGen ~ GPT powered, project documentation & manual generator

[zealous lodge]

Analyze code files, generate comprehensive documentation & in-depth instructions for each file and project summary.

Project works by using premade templates for various types of objective.
Example Template: [Code Documentation Gen 1]

Generate a brief documentation.md / manual.man file for the provided code snippet. 
The manual should be enclosed in a single code block without any special formatting or symbols like backticks (`).
The manual should include the following sections:
Use the Markdown.md formatting for README.md

Template:
### 'file_name + extension' 
# Name: "[Provide a name for script based on code provided]"
## Desc:
[Provide a brief description of what the script does.]

### Usage:
> [Explain how to use the script, including any required inputs or parameters.]

### Function:
> [Describe the main functionality and purpose of the script.]

### Note:
> [Include any important notes or considerations for users.]

Full project will soon be uploaded and available on:
https://github.com/GNU-Szmelc/DocXGen

EXTRA TEMPLATES:

┃ ~REVERSE #1  [Predict source code based on docs & template ]    ┃
┃ --------------------------------------------------------------- ┃
┃ Hey, i generated this: {DOCUMENTATION}                          ┃
┃ from a code snippet while using this: {TEMPLATE}                ┃
┃ --------------------------------------------------------------- ┃
┃ Can you please try to figure out the original code              ┃
┃ and/or as much info as possible having only this information?   ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ~REVERSE #2  [ Create documentation based on code & template ]  ┃
┃ --------------------------------------------------------------- ┃
┃ Hey, i generated this: {TEMPLATE} /OR {CODE}                    ┃
┃ from a code snippet: {CODE} \ {TEMPLATE}                        ┃
┃ --------------------------------------------------------------- ┃
┃ Can you please try to figure out the proper documentation       ┃
┃ and/or as much info as possible having only this information?   ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ~REVERSE #3  [ Create template based on code & docs ]           ┃
┃ --------------------------------------------------------------- ┃
┃ Hey, i generated this: {DOCUMENTATION}                          ┃
┃ from this code snippet: {CODE}                                  ┃
┃ --------------------------------------------------------------- ┃
┃ Can you please try to figure out the original template          ┃
┃ and/or as much info as possible having only this information?   ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛```

Simple experimental implementation

Create snippets directory, put your code to analyze there, run the script -> files with same name and format as source should appear in logs directory

Extra tool: [Simple Bash Code Compacter]

You can use it to combine all snippets into single longer file which still makes sense both for human and machine.

And finally some examples:

Example source code to analyze: