appledoc
2.2.1 build 1333
AVISO IMPORTANTE: se necesitan colaboradores
Appledoc es una herramienta de línea de comandos que ayuda a los desarrolladores de Objective-C a generar documentación de código fuente similar a Apple a partir de comentarios de código fuente con formato especial. Está diseñado para tomar comentarios de código fuente tan legibles como sea posible para la entrada y utilizar comentarios, así como el código fuente circundante, para generar documentación visualmente atractiva en forma de HTML, así como un conjunto de documentación Xcode totalmente indexada y navegable. Aunque existen varias herramientas que pueden crear documentación HTML para Objective-C, todas las que conozco no cumplen con los objetivos mínimos que se describen a continuación.
Objetivos principales de Appledoc:
Para que su experiencia con Appledoc sea lo más fluida posible, le sugerimos encarecidamente que lea este documento completo, así como toda la documentación en línea mencionada en la sección "uso de Appledoc" a continuación.
¡El uso de Appledoc está permitido según los términos enumerados en la sección LICENCIA al final de este archivo!
¿Quieres mantenerte actualizado? Síganos en Twitter: @gentlebytes.
La forma recomendada es clonar el proyecto GitHub y compilar la herramienta desde Xcode. Como la clonación del proyecto GitHub creará el enlace al repositorio principal, también simplifica enormemente las actualizaciones futuras. Para instalar, escriba lo siguiente en la Terminal:
git clone git://github.com/tomaz/appledoc.git
Esto crea el directorio appledoc. Dentro puede encontrar appledoc.xcworkspace Espacio de trabajo Xcode; ábralo y compile el objetivo de Appledoc; esto debería funcionar de inmediato, sin embargo, su sistema debe cumplir con los requisitos mínimos del sistema, consulte a continuación. Le recomiendo que copie el ejecutable Appledoc resultante del directorio de compilación a uno de los directorios en su ruta ( echo $PATH ) para que sea fácilmente accesible.
Opcional: Appledoc es autónomo y contiene los archivos de plantilla necesarios. SI desea modificar estos valores predeterminados del subdirectorio Plantillas a una de las ubicaciones esperadas:
También puede utilizar el script install-appledoc.sh para realizar una instalación rápida. Abra Terminal y cambie al directorio appledoc. Escriba el siguiente comando:
sudo sh install-appledoc.sh (if you need templates add '-t default')
Compila appledoc e instala su binario en /usr/local/bin y las plantillas (si se desea) en ~/.appledoc de forma predeterminada. Puede anular estos directorios con las opciones -b y -t respectivamente. Por ejemplo:
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
Alternativamente con Homebrew:
brew install appledoc
Homebrew no instala plantillas de forma predeterminada.
Utilice appledoc --help para ver la lista de todos los modificadores de la línea de comandos. Lea más sobre Appledoc en el sitio de Appledoc. Lea también las páginas wiki para obtener artículos más detallados.
Utilice el grupo Appledoc de Google como foro para preguntas sobre el uso u otras preguntas generales.
Utilice la página de problemas de Appledoc para enviar solicitudes de errores y funciones. Antes de enviar nuevos problemas, consulte los foros para ver si su pregunta tiene respuesta allí; a menos que pueda confirmar que su problema es una solicitud de nueva función o un error, debe comenzar en el foro para mantener limpios los problemas de GitHub. Lea también los problemas para ver si ya están ahí y vote sobre ellos o agregue un comentario (no se olvide de los problemas cerrados).
Para mantenerse actualizado, simplemente vaya a Terminal y acceda al directorio appledoc, ejecute git pull y vuelva a compilar appledoc.xcodeproj. No olvides sobrescribir el ejecutable de Appledoc que has copiado en $PATH :)
Si también desea compilar y ejecutar el objetivo AppledocTests (pruebas unitarias), debe copiar todos los marcos indicados dentro del grupo Bibliotecas y marcos al directorio de marcos compartidos antes de crear el objetivo de pruebas unitarias. Esto no es necesario para crear la herramienta Appledoc en sí.
Puede configurar Xcode para automatizar la creación de documentos Appledoc. Descubra cómo utilizar un Run Script y las fases de compilación de su proyecto.
La documentación y los conjuntos de documentos generados previamente para la mayoría de los marcos Cocoa están disponibles en:
Una vez que tenga un conjunto de documentos, es posible que desee utilizarlo con un navegador de documentación:
¿Tienes problemas? Esto es lo que puedes hacer para solucionar el problema:
git pull y ejecute nuevamente con la última versión.--verbose . El nivel predeterminado es 2, pero puede incrementar progresivamente la verbosidad hasta 6 y cada nivel le brinda información más detallada. Como esto le brindará mucha más información, es posible que desee concentrarse solo en un conjunto específico de archivos fuente con los que tenga problemas. Tenga en cuenta que aumentar la verbosidad dará como resultado un rendimiento más lento, por lo que no se recomienda utilizar niveles superiores a 4 para el uso diario.Si desea contribuir, consulte el archivo de Notas del desarrollador para obtener una breve descripción general de cómo funciona Appledoc internamente.
Appledoc tiene la licencia BSD modificada. En lenguaje sencillo: puedes hacer lo que quieras con el código, modificarlo, redistribuirlo, incrustarlo en tus productos (gratuitos o comerciales), pero debes incluir los derechos de autor, los términos de uso y la exención de responsabilidad como se indica en la licencia, los mismos como cualquier otro código con licencia BSD. Por supuesto, puedes utilizar la documentación generada por Appledoc para tus productos (gratuita o comercial), pero debes atribuir Appledoc ya sea en la documentación misma o en otro lugar apropiado, como tu sitio web.
Si por alguna razón no puede aceptar estos términos, contáctenos a través del formulario de contacto en nuestra página Acerca de, ¡haremos todo lo posible para ayudarlo y encontrar una solución viable!
Copyright (c) 2009-2011, Gentle Bytes Todos los derechos reservados.
Se permite la redistribución y el uso en formato fuente, binario y documentación generada, con o sin modificación, siempre que se cumplan las siguientes condiciones:
Las redistribuciones del código fuente deben conservar el aviso de derechos de autor anterior, esta lista de condiciones y el siguiente descargo de responsabilidad.
Las redistribuciones en formato binario deben reproducir el aviso de derechos de autor anterior, esta lista de condiciones y la siguiente exención de responsabilidad en la documentación y/u otros materiales proporcionados con la distribución.
Las redistribuciones de la documentación generada por Appledoc deben incluir la atribución a Appledoc, ya sea en la documentación misma o en otros medios apropiados.
Ni el nombre de Appledoc, Gentle Bytes ni los nombres de sus colaboradores pueden usarse para respaldar o promocionar productos derivados de este software sin un permiso previo específico por escrito.
ESTE SOFTWARE ES PROPORCIONADO POR LOS TITULARES DE DERECHOS DE AUTOR Y COLABORADORES "TAL CUAL" Y SE RENUNCIA A CUALQUIER GARANTÍA EXPRESA O IMPLÍCITA, INCLUYENDO, PERO NO LIMITADO A, LAS GARANTÍAS IMPLÍCITAS DE COMERCIABILIDAD E IDONEIDAD PARA UN PROPÓSITO PARTICULAR. EN NINGÚN CASO EL TITULAR DE LOS DERECHOS DE AUTOR O LOS COLABORADORES SERÁN RESPONSABLES DE NINGÚN DAÑO DIRECTO, INDIRECTO, INCIDENTAL, ESPECIAL, EJEMPLAR O CONSECUENTE (INCLUYENDO, PERO NO LIMITADO A, ADQUISICIÓN DE BIENES O SERVICIOS SUSTITUTOS; PÉRDIDA DE USO, DATOS O GANANCIAS; O INTERRUPCIÓN DEL NEGOCIO) CUALQUIER CAUSA Y EN CUALQUIER TEORÍA DE RESPONSABILIDAD, YA SEA POR CONTRATO, RESPONSABILIDAD ESTRICTA O AGRAVIO (INCLUYENDO NEGLIGENCIA O DE OTRA MANERA) QUE SURJA DE CUALQUIER MANERA DEL USO DE ESTE SOFTWARE, INCLUSO SI SE ADVIERTE DE LA POSIBILIDAD DE DICHO DAÑO.
Bytes gentiles [email protected]
