Automatic Documentation

Kodezi Code automatically generates clear, organized documentation for your project — including comments, API references, README sections, and OpenAPI specifications. This helps you maintain clarity and consistency without manually writing long docs.

What Kodezi Can Document

Kodezi supports multiple documentation formats:

1. Code Comments

Automatic comments describing:

• Function purpose
• Parameters
• Return values
• Edge cases

Example: Code Comments

// Calculates the sum of two numbers
// @param {number} a - First number
// @param {number} b - Second number
// @returns {number} Total sum
function add(a, b) {
  return a + b;
}

2. API Documentation

Detailed endpoint docs with:

• Descriptions
• Request/response schemas
• Auth requirements
• Example calls

Example: Auto Generated API Documentation

openapi: 3.0.0
info:
  title: Example Data API
  version: 1.0.0

paths:
  /data:
    get:
      summary: Fetch application data
      description: Retrieves a list of items used in the React app on mount.
      responses:
        '200':
          description: Successful response with data
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataItem'

3. README Generation

Kodezi can generate README files that include:

• Project overview
• Setup instructions
• Usage examples
• Folder structure
• Configuration steps

4. OpenAPI Specs

Full schema based API documentation created automatically from your backend code.

Perfect for:

• Full API specification
• Schema definitions
• Response types
• Error codes

How to Generate Documentation

Follow these steps to create documentation automatically:

1. Open a file or select a code block.
2. Navigate to AI Tools → Generate Docs.
3. Choose the documentation type you need.
4. Review the generated output.
5. Insert, copy, or refine the documentation.

Kodezi can also update existing docs to keep them aligned with your code changes.