Estoy leyendo en el artículo cómo generar una documentación HTML similar a Apple en here. Mis preguntas son para qué se usan las líneas de comando. ¿Cómo podemos combinar líneas de comando y Appledoc xcode project para generar un HTML?cómo usar appledoc para generar una documentación similar a Apple
No he utilizado 'appledoc', pero a partir de un vistazo rápido a la página que vinculó parece que es una utilidad de línea de comandos de código abierto. Así que el primer paso será compilar el programa 'appledoc' en sí mismo, y luego pegarlo en un directorio que esté en su camino, como /usr/local/bin o ~/bin/.
El siguiente paso es tratar de usarlo para generar cierta documentación (suponiendo que ya haya creado los archivos de reducción que consume). Abra una ventana de terminal, vaya al directorio donde los archivos son, y luego usar la orden dada en la parte superior de la página que se conectó:
appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .
Si desea utilizar 'appledoc' para regenerar la documentación de cada Cuando construya un proyecto, puede agregar una fase de compilación "Ejecutar script" a un destino existente en su proyecto, o crear un nuevo objetivo solo para la documentación que no tiene más que una fase de compilación "Ejecutar script". De cualquier manera, el script en esa fase debe ser script de shell que contenga un comando similar al anterior (aunque probablemente desee especificar el directorio de origen explícitamente en lugar de simplemente usar el directorio 'actual', es decir, .).
Soy el autor de la herramienta appledoc. La herramienta está pensada para ser utilizada según lo respondido por Caleb arriba. El método de instalación recomendado es clonar el repositorio de GitHub, abrir el proyecto en Xcode, compilar y, opcionalmente, copiar el binario a su ruta, como se sugirió anteriormente. Además, también debe copiar los archivos de plantilla necesarios para ejecutar la herramienta en una de las rutas predefinidas. Todos los pasos requeridos se describen en el archivo léame en la página appledoc en GitHub, consulte la sección Instalación rápida.
También existen otros métodos para instalar - toda contribución de los usuarios:
install-appledoc.sh script incluido en el repositorio git.Para cualquier pregunta adicional vaya a appledoc Google group. Acabo de crearlo hace unos días, por lo que no hay contenido en el momento de escribir esto, pero no dude en hacer preguntas allí.
Como ya he encontrado en esta post, se puede generar una documentación HTML completa de su código con esta línea de comandos:
appledoc --project nombre BabelCPP --project-empresa "mi nombre" - -company-id com.mycompany --no-create-docset --output ./doc/.
El último "." es el camino a tu código
Dudo que la mayoría de la gente esté familiarizada con el proyecto 'appledoc', por lo que es posible que desee explicar su pregunta un poco más. – Caleb