From 731408507a5d5c1e88dda1de3073c6bcf90cdc77 Mon Sep 17 00:00:00 2001 From: Jorge Cuadrado Date: Thu, 4 Oct 2007 15:22:43 -0500 Subject: [PATCH] Documentation --- Doxyfile | 21 +++++++++--------- doc/dox/mainpage_en.dox | 11 ++++++++++ doc/dox/mainpage_es.dox | 58 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/dox/modules.dox | 32 +++++++++++++++++++++++++++ 4 files changed, 111 insertions(+), 11 deletions(-) create mode 100644 doc/dox/mainpage_en.dox create mode 100644 doc/dox/mainpage_es.dox create mode 100644 doc/dox/modules.dox diff --git a/Doxyfile b/Doxyfile index a53fded..f0a2e88 100644 --- a/Doxyfile +++ b/Doxyfile @@ -3,11 +3,11 @@ #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -PROJECT_NAME = dash +PROJECT_NAME = Dash PROJECT_NUMBER = 0.1 OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English +OUTPUT_LANGUAGE = spanish USE_WINDOWS_ENCODING = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES @@ -82,7 +82,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = /home/krawek/Proyectos/dash +INPUT = src doc/dox FILE_PATTERNS = *.c \ *.cc \ *.cxx \ @@ -129,7 +129,6 @@ FILE_PATTERNS = *.c \ *.tlh \ *.diff \ *.patch \ - *.moc \ *.xpm \ *.dox RECURSIVE = yes @@ -164,7 +163,7 @@ IGNORE_PREFIX = # configuration options related to the HTML output #--------------------------------------------------------------------------- GENERATE_HTML = YES -HTML_OUTPUT = html +HTML_OUTPUT = doc/html HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = @@ -183,8 +182,8 @@ TREEVIEW_WIDTH = 250 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -GENERATE_LATEX = YES -LATEX_OUTPUT = latex +GENERATE_LATEX = NO +LATEX_OUTPUT = doc/latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO @@ -214,8 +213,8 @@ MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- -GENERATE_XML = yes -XML_OUTPUT = xml +GENERATE_XML = no +XML_OUTPUT = doc/xml XML_SCHEMA = XML_DTD = XML_PROGRAMLISTING = YES @@ -239,14 +238,14 @@ EXPAND_ONLY_PREDEF = NO SEARCH_INCLUDES = YES INCLUDE_PATH = INCLUDE_FILE_PATTERNS = -PREDEFINED = +PREDEFINED = GNUC__ QT_GUI_LIB QT_CORE_LIB DGUI_LIB DCORE_LIB QT_OPENGL_LIB EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- TAGFILES = -GENERATE_TAGFILE = dash.tag +GENERATE_TAGFILE = yamf.tag ALLEXTERNALS = NO EXTERNAL_GROUPS = YES PERL_PATH = /usr/bin/perl diff --git a/doc/dox/mainpage_en.dox b/doc/dox/mainpage_en.dox new file mode 100644 index 0000000..17a148a --- /dev/null +++ b/doc/dox/mainpage_en.dox @@ -0,0 +1,11 @@ +/** +@~english +@mainpage Dash + +@section intro Introduction + + + +*/ + + diff --git a/doc/dox/mainpage_es.dox b/doc/dox/mainpage_es.dox new file mode 100644 index 0000000..183c872 --- /dev/null +++ b/doc/dox/mainpage_es.dox @@ -0,0 +1,58 @@ +/** +@~spanish +@mainpage Dash +@section intro Introducción + +Dash es una herramienta para la producción de contenidos multimedia. + +Actualmente Dash permite la creacion de animaciónes 2D, con soporte para: + - Ilustración: + - Herramientas basicas de: + -# Dibujo. + -# Selección y edición de contronos. + - Papel cebolla. + - Filtros sobre elemetos graficos. + - Creación de degradados. + - Selección de colores y degradados. + - Biblioteca de objetos. + + - Animación: + - Line de tiempo, para moverse y visualizar la animación. + - Interpolacion de movimiento(tweening). + - Exportar a diversos formatos de video (swf, avi, ogg...). + - Incorparacion de sonido, imagenes vectoriales (svg) y imgenes de mapa de bits(BMP, JPG, JPEG, PNG, PPM, TIFF, XBM, XPM) a la animación. + + - Producción colaborativa: + - Creación de animaciones de forma colaborativa utilizando Dashemon como un servidor centralizado para permitir el trabajo concurrente de múltiples artistas sobre un proyecto. + +@section install Instalación + +Para compilar e instalar Dash necesitamos de Ruby. + +Dash utiliza QOnf para el proceso de construcción e instalación. + +Proceso de compilación e instalación: + -# Descargue y descomprima las fuentes de Dash + -# Ejecute en la consola de comando $> ruby qonfigure.rb + -# configure las rutas: + * Donde desea instalar Dash. + * Donde se encuentra instalada YAMF. + * Donde se encuentra instalada DLib. + -# $> make + -# $> make install + +@subsection deps Dependencias +La principal dependencia de Dash es YAMF. + +@subsection future Futuro +En el futuro Dash pretende dar soporte para: +-# La creación de sitios web multimedia. +-# La creación de multimedia mediante lenguajes script. + +@section Acknowledgements Agradecimientos +Gracias a: +@li Trolltech: Por su maravilloso framework Qt. +@li Doxygen: Nosotros usamos esta genial herramienta de documentación. +@li Todos los desarrolladores de software libre al rededor del mundo. +*/ + diff --git a/doc/dox/modules.dox b/doc/dox/modules.dox new file mode 100644 index 0000000..1312a74 --- /dev/null +++ b/doc/dox/modules.dox @@ -0,0 +1,32 @@ + +/** +@defgroup common Common +*/ + +/** +@defgroup gui GUI +*/ + +/** +@defgroup tools Tools +*/ + +/** +@defgroup drawing Drawing +*/ + +/** +@defgroup model Model +*/ + +/** +@defgroup effect Effect +*/ + +/** +@defgroup item Item +*/ + +/** +@defgroup render Render +*/ \ No newline at end of file -- 2.11.4.GIT