docc2json
Herramienta CLI rápida y eficiente para transformar documentación DocC de Xcode en archivos JSON estructurados.
docc2json convierte la documentación DocC de Xcode en archivos JSON optimizados para sitios web y SDK. Incluye funciones avanzadas de extracción y agrupación.
Más sobre docc2json
docc2json
docc2json es una herramienta de línea de comandos escrita en Go que convierte la documentación DocC de Xcode en un archivo JSON optimizado para sitios web y SDK. Permite la extracción completa de información, incluyendo firmas de métodos y ejemplos de código. Simplifica la integración de la documentación de tu SDK en plataformas web.
- •Extracción completa de documentación:Extrae resúmenes, discusiones, ejemplos y listados de código de los comentarios DocC. Asegura que toda la información relevante se conserve en el proceso de conversión.
- •Generación de esquema SDK personalizado:Crea un esquema JSON estructurado con información completa de tipos, firmas de métodos y documentación. Facilita la integración en sitios web y otras plataformas.
- •Conversión rápida y eficiente:Procesa archivos JSON en paralelo para una conversión rápida. Permite procesar grandes cantidades de documentación en menos de un segundo.
- •Filtrado por nivel de acceso:Permite filtrar símbolos por nivel de acceso con la opción `--public-only`. Asegura que solo la API pública se incluya en la documentación generada.
- •Resolución de referencias cruzadas:Resuelve las referencias cruzadas para las relaciones de tipos y las conformidades de protocolo. Mantiene la integridad de la documentación.
- •Soporte para artículos y tutoriales:Incluye opcionalmente artículos y tutoriales de documentación. Permite una documentación más completa y fácil de usar.
- •Agrupación flexible de tipos:Ofrece opciones de agrupación flexibles, incluyendo agrupación por prefijo y configuración YAML personalizada. Mejora la organización en los sitios de documentación.
- •Conversión de nombres de protocolo:Convierte automáticamente nombres de protocolos Swift y Objective-C. Simplifica la legibilidad de la documentación.
- •Filtrado inteligente de conformidades:Filtra automáticamente los protocolos de la biblioteca estándar de Swift. Mantiene la documentación enfocada en los protocolos personalizados.
Con docc2json, la documentación de tu SDK se transforma en una experiencia web optimizada y fácil de integrar. Simplifica el flujo de trabajo de documentación, ahorrando tiempo y mejorando la claridad para los desarrolladores. Al elegir esta herramienta, aseguras una documentación precisa, completa y lista para ser utilizada en cualquier plataforma.
