Aquila.CodeDocument 5.0.1

Aquila.CodeDocument

Author: Aswin SAdhasivam Company: Aquila Innovations

You can copy this directly into:

README.md

📘 Aquila.CodeDocument

Automatic Code Documentation & Android Permission Tracking for .NET MAUI

Aquila.CodeDocument is a build-time documentation generator for .NET MAUI Android (net9.0-android) projects.

It automatically:

📄 Merges all .cs and .xaml files into a single documentation file

🔐 Extracts Android permissions from AndroidManifest.xml

📊 Maps permissions to source files using them

⚙ Runs automatically after successful build

🚀 Requires zero runtime code

✨ Features 1️⃣ Code Documentation Generator

When enabled, Aquila.CodeDocument:

Scans all project .cs and .xaml files

Excludes bin and obj

Merges full file content into:

ProjectFolder/ └── AquilaCodeDocument/ └── AquilaCodeDocument.txt

2️⃣ Android Permission Tracking

When enabled, Aquila.CodeDocument:

Reads:

Platforms/Android/AndroidManifest.xml

Extracts all:

<uses-permission android:name="..." />

Scans .cs files

Detects which files use each permission

Generates:

ProjectFolder/ └── AquilaCodeDocument/ └── AquilaPermissions.txt

Example output:

Permission: android.permission.CAMERA Used In:

• CameraPage.cs
• ScanService.cs

📦 Installation Using .NET CLI dotnet add package Aquila.CodeDocument

Using Visual Studio

Right click project

Manage NuGet Packages

Search Aquila.CodeDocument

Install

⚙ Requirements

.NET 9 SDK

.NET MAUI

Target framework:

<TargetFramework>net9.0-android</TargetFramework>

⚠ This package runs only for Android builds.

🚀 Usage Guide

Add the following inside your .csproj:

<PropertyGroup> <aquilacodedocument>true</aquilacodedocument> <aquilacodedocument_trackPermission>true</aquilacodedocument_trackPermission> </PropertyGroup>

🔹 Enable Code Documentation Only <aquilacodedocument>true</aquilacodedocument>

🔹 Enable Permission Tracking Only <aquilacodedocument_trackPermission>true</aquilacodedocument_trackPermission>

🔹 Enable Both <PropertyGroup> <aquilacodedocument>true</aquilacodedocument> <aquilacodedocument_trackPermission>true</aquilacodedocument_trackPermission> </PropertyGroup>

📂 Output Structure

After successful build:

YourProject/ └── AquilaCodeDocument/ ├── AquilaCodeDocument.txt └── AquilaPermissions.txt

🔄 When Does It Run?

After successful Build

Only for:

net9.0-android

Does NOT affect iOS, Windows, or Mac builds

Does NOT affect runtime performance

🛡 Performance Design

Excludes bin/ and obj/

Runs only when property enabled

Lightweight scanning

Safe for Debug & Release builds

🧠 How It Works

Aquila.CodeDocument uses:

MSBuild .props

MSBuild .targets

Custom MSBuild Tasks

Post-build execution hook

No runtime dependencies.

No reflection.

No source generators.

Pure build-time automation.

📌 Use Cases

📑 Project archival documentation

🧾 Compliance documentation

🔐 Security review reports

🏢 Enterprise audits

🧑‍🏫 Academic project submission

🧪 QA validation

🛠 Developer onboarding

⚠ Limitations

Android only

Permission detection uses keyword matching

Does not analyze reflection-based permission calls

Future versions may include Roslyn-based analysis.

🔮 Roadmap

Planned features:

Markdown output

JSON metadata output

Permission usage graph

Architecture dependency mapping

Roslyn analyzer edition

CI/CD integration

Visual Studio extension

🏢 About

Author: Aswin SAdhasivam Company: Aquila Innovations

Aquila.CodeDocument is part of Aquila’s developer tooling ecosystem focused on:

Build automation

Code intelligence

Enterprise tooling

Productivity enhancement

📜 License

MIT License

🤝 Contributing

Contributions welcome.

If you discover issues or have feature requests, please open an issue on the repository.

⭐ Support

If this package helps your workflow, please:

⭐ Star the repository

💬 Share feedback

📢 Recommend to other developers

💬 Example Scenario

You are preparing an Android MAUI app for security audit.

Instead of manually collecting:

All source files

All permissions

Permission usage mapping

You simply:

<aquilacodedocument>true</aquilacodedocument> <aquilacodedocument_trackPermission>true</aquilacodedocument_trackPermission>

Build.

Documentation generated automatically.

🎯 Final Thoughts

Aquila.CodeDocument turns your build process into an automatic documentation engine.

Zero effort. Maximum visibility. Enterprise-ready.