# ApiExplorer - World of Warcraft API Browser

## English Description

### Overview

ApiExplorer is a comprehensive visual API browser for World of Warcraft addon developers. Explore the complete WoW API with an intuitive interface, powerful search capabilities, and developer-friendly tools. Updated for World of Warcraft Midnight (Interface 120000).

### Key Features

#### 🔍 **Advanced Search & Filtering**

- **Global Search**: Search across all APIs by name, description, or label

- **Type-Based Search**: Filter functions by argument types or return types

- Example: `arg:unitID` or `returns:table`

- **API Type Filtering**: Filter by Internal, External, or Protected APIs

- **Show New Functions**: Highlight newly added APIs in the current patch

- **Search History**: Automatic tracking of recent searches for quick access

#### 📋 **Function Management**

- **Compare Functions**: Select 2-3 functions to compare side-by-side

- Highlights differences in arguments and return values

- Perfect for understanding similar APIs

- **Copy to Clipboard**: Multiple copy formats

- Full signature: `C_Timer.After(seconds, callback) -> void`

- Name only: `C_Timer.After`

- Usage examples

- Lua comment blocks

- **Personal Notes**: Add custom notes to any function

- Auto-saves to SavedVariables

- Filter to show only functions with notes

- Search within notes

#### 🧪 **Developer Tools**

- **Test Generator**: Generate `/run` commands to test functions in-game

- Automatic example value generation

- Test history (last 10 commands)

- One-click copy to clipboard

- **Usage Scanner**: Detect which API functions your addon uses

- Scan addon files for API calls

- Identify deprecated functions in use

- Filter by used/unused functions

- **Export Namespace**: Export complete namespace documentation

- Markdown format (for documentation)

- Lua comments (for code)

- JSON format (for tools)

- Options to exclude deprecated or include examples

#### 🎨 **Visual Enhancements**

- **Type Icons**: Color-coded icons for data types

- Blue for numbers, Green for strings, Orange for booleans, Purple for tables, Cyan for functions

- **Function Counters**: See function counts in categories

- Format: `C_Timer (5) [2 new]`

- Total visible vs total functions in header

- **Compact Mode**: Reduce row height to see more functions

- Toggle between normal (24px) and compact (18px) views

- Preference saved automatically

- **Search Highlighting**: Matching text highlighted in yellow

- Works in function names, descriptions, arguments, and returns

- **Status Badges**: Visual indicators for function status

- [NEW] for newly added functions

- [DEPRECATED] for deprecated functions

- [PROTECTED] for protected functions

- [USED] for functions your addon uses

- [NOTE] for functions with personal notes

#### 🔗 **Navigation**

- **Function Links**: Clickable references between related functions

- Automatically detected in descriptions

- Hover for quick preview tooltip

- Click to navigate instantly

- **Remember Last View**: Automatically restores your last viewed function

- Saves category, namespace, function, and scroll position

- Option to always start fresh

- **Expand/Collapse Categories**: Manage navigation panel

- Expand All / Collapse All buttons

- Double-click to toggle individual categories

- Expansion state saved automatically

#### 🌍 **Localization**

- **English** (enUS) - Full support

- **Spanish** (esES) - Full support

- **German** (deDE) - Full support

- **French** (frFR) - Full support

- **Portuguese** (ptBR) - Full support

### Commands

- `/api` - Toggle ApiExplorer window

- `/api lang <code>` - Change language (enUS, esES, deDE, frFR, ptBR, auto)

- `/api reset` - Reset all settings to defaults

- `/api debug` - Toggle debug mode

### Requirements

- World of Warcraft Midnight (Interface 120000) or later

- No dependencies on other addons

### Perfect For

- Addon developers learning the WoW API

- Experienced developers looking up function signatures

- Debugging addon code and finding deprecated functions

- Documenting addon functionality

- Teaching others about WoW API capabilities

### Tips & Tricks

1. **Quick Copy**: Use the Copy button to get function signatures in multiple formats

2. **Compare APIs**: Select 2-3 similar functions to understand their differences

3. **Test in-game**: Use the Test button to generate `/run` commands

4. **Track Usage**: Scan your addon to find which APIs you're using

5. **Personal Notes**: Add notes to functions you frequently use

6. **Compact View**: Enable compact mode to see more functions at once

7. **Search by Type**: Use `arg:spellID` to find all functions accepting spell IDs

### Version History

- **2.1.0** - Midnight update with advanced features

- Added comparison view for side-by-side function analysis

- Added clipboard helper for automatic copying

- Added personal notes system

- Added usage scanner for addon analysis

- Added test command generator

- Added export functionality

- Added type-based search

- Added function linking system

- Added compact mode

- Added search highlighting

- Added type icons

- Added function counters

- Added state persistence

---

## Descripción en Español

### Descripción General

ApiExplorer es un navegador visual completo de la API de World of Warcraft para desarrolladores de addons. Explora la API completa de WoW con una interfaz intuitiva, potentes capacidades de búsqueda y herramientas amigables para desarrolladores. Actualizado para World of Warcraft Midnight (Interface 120000).

### Características Principales

#### 🔍 **Búsqueda y Filtrado Avanzado**

- **Búsqueda Global**: Busca en todas las APIs por nombre, descripción o etiqueta

- **Búsqueda por Tipo**: Filtra funciones por tipos de argumentos o retornos

- Ejemplo: `arg:unitID` o `returns:table`

- **Filtrado por Tipo de API**: Filtra por APIs Internas, Externas o Protegidas

- **Mostrar Funciones Nuevas**: Destaca las APIs recién añadidas en el parche actual

- **Historial de Búsqueda**: Seguimiento automático de búsquedas recientes

#### 📋 **Gestión de Funciones**

- **Comparar Funciones**: Selecciona 2-3 funciones para compararlas lado a lado

- Destaca diferencias en argumentos y valores de retorno

- Perfecto para entender APIs similares

- **Copiar al Portapapeles**: Múltiples formatos de copia

- Firma completa: `C_Timer.After(seconds, callback) -> void`

- Solo nombre: `C_Timer.After`

- Ejemplos de uso

- Bloques de comentarios Lua

- **Notas Personales**: Añade notas personalizadas a cualquier función

- Auto-guardado en SavedVariables

- Filtra para mostrar solo funciones con notas

- Busca dentro de las notas

#### 🧪 **Herramientas para Desarrolladores**

- **Generador de Pruebas**: Genera comandos `/run` para probar funciones en el juego

- Generación automática de valores de ejemplo

- Historial de pruebas (últimos 10 comandos)

- Copia de un clic al portapapeles

- **Escáner de Uso**: Detecta qué funciones de API usa tu addon

- Escanea archivos del addon para llamadas de API

- Identifica funciones deprecated en uso

- Filtra por funciones usadas/no usadas

- **Exportar Namespace**: Exporta documentación completa del namespace

- Formato Markdown (para documentación)

- Comentarios Lua (para código)

- Formato JSON (para herramientas)

- Opciones para excluir deprecated o incluir ejemplos

#### 🎨 **Mejoras Visuales**

- **Iconos de Tipo**: Iconos codificados por color para tipos de datos

- Azul para números, Verde para strings, Naranja para booleanos, Púrpura para tablas, Cyan para funciones

- **Contadores de Funciones**: Ve conteos de funciones en categorías

- Formato: `C_Timer (5) [2 new]`

- Total visible vs total de funciones en el encabezado

- **Modo Compacto**: Reduce la altura de las filas para ver más funciones

- Alterna entre vistas normal (24px) y compacta (18px)

- Preferencia guardada automáticamente

- **Resaltado de Búsqueda**: Texto coincidente resaltado en amarillo

- Funciona en nombres de funciones, descripciones, argumentos y retornos

- **Insignias de Estado**: Indicadores visuales para el estado de la función

- [NEW] para funciones recién añadidas

- [DEPRECATED] para funciones deprecated

- [PROTECTED] para funciones protegidas

- [USED] para funciones que usa tu addon

- [NOTE] para funciones con notas personales

#### 🔗 **Navegación**

- **Enlaces de Función**: Referencias clickeables entre funciones relacionadas

- Detectadas automáticamente en descripciones

- Hover para vista previa rápida

- Click para navegar instantáneamente

- **Recordar Última Vista**: Restaura automáticamente tu última función vista

- Guarda categoría, namespace, función y posición de scroll

- Opción para siempre empezar de nuevo

- **Expandir/Colapsar Categorías**: Gestiona el panel de navegación

- Botones Expandir Todo / Colapsar Todo

- Doble clic para alternar categorías individuales

- Estado de expansión guardado automáticamente

### Comandos

- `/api` - Alterna la ventana de ApiExplorer

- `/api lang <código>` - Cambia idioma (enUS, esES, deDE, frFR, ptBR, auto)

- `/api reset` - Reinicia todos los ajustes a valores predeterminados

- `/api debug` - Alterna modo debug

### Requisitos

- World of Warcraft Midnight (Interface 120000) o posterior

- Sin dependencias de otros addons

### Perfecto Para

- Desarrolladores de addons aprendiendo la API de WoW

- Desarrolladores experimentados buscando firmas de funciones

- Depuración de código de addon y búsqueda de funciones deprecated

- Documentación de funcionalidad de addon

- Enseñanza de capacidades de la API de WoW

---

## Descripción en Alemán

### Übersicht

ApiExplorer ist ein umfassender visueller API-Browser für World of Warcraft-Addon-Entwickler. Erkunden Sie die vollständige WoW-API mit einer intuitiven Benutzeroberfläche, leistungsstarken Suchfunktionen und entwicklerfreundlichen Tools. Aktualisiert für World of Warcraft Midnight (Interface 120000).

### Hauptmerkmale

- **Erweiterte Suche**: Globale Suche, Typbasierte Filterung, API-Typ-Filterung

- **Funktionsverwaltung**: Funktionen vergleichen, in die Zwischenablage kopieren, persönliche Notizen

- **Entwickler-Tools**: Test-Generator, Verwendungsscanner, Namespace-Export

- **Visuelle Verbesserungen**: Typ-Symbole, Funktionszähler, Kompaktmodus, Suchhervorhebung

- **Navigation**: Funktionslinks, Letzte Ansicht merken, Kategorien erweitern/reduzieren

- **Lokalisierung**: Englisch, Spanisch, Deutsch, Französisch, Portugiesisch

---

## Descripción en Francés

### Aperçu

ApiExplorer est un navigateur API visuel complet pour les développeurs d'extensions World of Warcraft. Explorez l'API WoW complète avec une interface intuitive, des capacités de recherche puissantes et des outils conviviaux pour les développeurs. Mis à jour pour World of Warcraft Midnight (Interface 120000).

### Caractéristiques Principales

- **Recherche Avancée**: Recherche globale, filtrage par type, filtrage par type d'API

- **Gestion des Fonctions**: Comparer les fonctions, copier dans le presse-papiers, notes personnelles

- **Outils pour Développeurs**: Générateur de tests, scanner d'utilisation, export d'espace de noms

- **Améliorations Visuelles**: Icônes de type, compteurs de fonctions, mode compact, mise en évidence de la recherche

- **Navigation**: Liens de fonction, mémoriser la dernière vue, développer/réduire les catégories

- **Localisation**: Anglais, Espagnol, Allemand, Français, Portugais

---

## Descripción en Portugués

### Visão Geral

ApiExplorer é um navegador de API visual abrangente para desenvolvedores de extensões do World of Warcraft. Explore a API completa do WoW com uma interface intuitiva, poderosos recursos de pesquisa e ferramentas amigáveis ao desenvolvedor. Atualizado para World of Warcraft Midnight (Interface 120000).

### Principais Características

- **Pesquisa Avançada**: Pesquisa global, filtragem por tipo, filtragem por tipo de API

- **Gerenciamento de Funções**: Comparar funções, copiar para a área de transferência, notas pessoais

- **Ferramentas para Desenvolvedores**: Gerador de testes, scanner de uso, exportação de namespace

- **Melhorias Visuais**: Ícones de tipo, contadores de funções, modo compacto, destaque de pesquisa

- **Navegação**: Links de função, lembrar última visualização, expandir/recolher categorias

- **Localização**: Inglês, Espanhol, Alemão, Francês, Português

---

## Installation & Support

### How to Install

1. Download ApiExplorer from CurseForge

2. Extract to your `World of Warcraft/_retail_/Interface/AddOns/` folder

3. Restart World of Warcraft

4. Type `/api` to open the addon

### Getting Help

- Check the in-game help: `/api help`

- Review the feature guide in the addon

- Report issues on CurseForge

### License

This addon is provided as-is for the World of Warcraft community.

---

**Last Updated**: January 2025

**Interface Version**: 120000 (Midnight)

**Status**: Fully Functional & Feature Complete