Repositorio con la documentación de EMMA:
Swift DocC es el framework oficial para documentar código swift. Ofrece tres tipos de documentación:
Lo bueno de Swift DocC es que toda la documentación puede estar conectada entre estos tres tipos de documentos, algo que he echado de menos en la documentación de EMMA, y puede solucionarse teniendo la documentación organizada con Swift DocC.
Se puede combinar la documentación en el código (marcando cada método, etc.) con la creación de documentación adicional (Articles / Tutorials) que apoyen esta documentación para el usuario:
El código que documentemos pasará al DocC, pero a su vez podemos crear otros archivos de documentación manualmente (llamados Catalog) que complementarán esta documentación.
⚠️ Importante: debe existir un código compilable para que la documentación sea generada.
Hay tres diferentes formas:
Siguiendo la ruta Product / Build Documentation la documentación se compilará y aparecerá automáticamente la página de documentación oficial de Apple, con nuestra documentación en local.
Siguiendo la ruta Target / Build Settings / Documentation Compiler Options podremos marcar la opción Build Documentation During ‘Build’ para que cada vez que compilemos el proyecto, también se compile la documentación:
Opción automática de compilación de documentación desactivada