Generating Documentation with AI Agents

/**
 * Calculates total cost including tax.
 * @param {Object} params - Input parameters
 * @param {number} params.price - Price per unit
 * @param {number} params.quantity - Number of units
 * @returns {number} Total cost including tax
 */
function calculateTotal({ price, quantity }) {
  const taxRate = 0.08;
  return (price * quantity) * (1 + taxRate);
}

{
  "ai": {
    "agent": "llm-readme-generator",
    "template": {
      "type": "standard"
    }
  },
  "output": {
    "path": "./README.md"
  }
}

/**
 * Calculates the area of a rectangle.
 * @param {number} width - The width of the rectangle
 * @param {number} height - The height of the rectangle
 * @returns {number} The area of the rectangle
 */
function calculateArea(width, height) {
  return width * height;
}

# calculateArea

Calculates the area of a rectangle.

## Parameters

- **width** (number) - The width of the rectangle
- **height** (number) - The height of the rectangle

## Returns

- (number) - The area of the rectangle

plantuml -t png -o ./diagrams ./src/MyClass.java

name: Update Docs on Code Change
on:
  push:
    branches:
      - main
jobs:
  update-docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Generate docs
        run: |
          npm run generate-docs
      - name: Commit and push changes
        run: |
          git config --local user.email "bot@example.com"
          git config --local user.name "AI Bot"
          git add .
          git commit -m "Update docs from code changes" || echo "No changes to commit"
          git push

feat(auth): Add login endpoint

- New POST /login endpoint with JWT token generation
- Includes validation for email and password fields
- Returns 200 OK on successful login

Fixes #123

refactor(api): Rename user endpoints

- /user/profile renamed to /profile
- /user/settings renamed to /settings
- Breaking change for existing clients

Closes #456

const translated = translate(
  "The AI agent can generate code from natural language descriptions.",
  "es"
);
console.log(translated); // "El agente de IA puede generar código a partir de descripciones en lenguaje natural."

function processUserData(data, options) {
  const result = [];
  for (let i = 0; i < data.length; i++) {
    const item = data[i];
    if (item.active && item.email) {
      const processed = {
        id: item.id,
        name: item.name,
        email: item.email.toLowerCase(),
        lastLogin: new Date().toISOString()
      };
      result.push(processed);
    }
  }
  return result;
}

Summary:
- Function processes user data.
- Filters for active users with email.
- Returns array of processed user objects.
- Each object includes ID, name, lowercase email, and last login timestamp.