From 01eee1c3d55044cb0c0ee84c3edd65adde52cd0e Mon Sep 17 00:00:00 2001 From: bruno Date: Fri, 12 Jun 2015 16:07:08 -0300 Subject: [PATCH] Adicionando documentação --- Makefile | 2 +- README | 8 -------- README.md | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ doc_config | 367 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ include/pyClip.h | 55 ++++++++++++++++++++++++++++++++++++++++++++++--------- plugin/corePlugin.h | 15 +++++++++++++++ workflow/coreExecute.png | Bin 0 -> 38198 bytes workflow/coreFinalize.png | Bin 0 -> 26976 bytes workflow/coreInitialize.png | Bin 0 -> 27273 bytes workflow/icon_vlibras.ico | Bin 0 -> 370070 bytes workflow/visao geral da arquitetura.png | Bin 0 -> 40419 bytes 11 files changed, 489 insertions(+), 18 deletions(-) delete mode 100644 README create mode 100644 README.md create mode 100644 doc_config create mode 100644 workflow/coreExecute.png create mode 100644 workflow/coreFinalize.png create mode 100644 workflow/coreInitialize.png create mode 100644 workflow/icon_vlibras.ico create mode 100644 workflow/visao geral da arquitetura.png diff --git a/Makefile b/Makefile index 6da6563..88c3c49 100644 --- a/Makefile +++ b/Makefile @@ -75,4 +75,4 @@ test-plugin: #Gera documentação doc: - + doxygen doc_config diff --git a/README b/README deleted file mode 100644 index 1af5743..0000000 --- a/README +++ /dev/null @@ -1,8 +0,0 @@ -############################## README VLIBRAS ############################## -# # -# Bruno Santos # -# brunosantos@lavid.ufpb.br # -# Repositório do sistema VLibras-Core para a plataforma Windows # -############################################################################ - - diff --git a/README.md b/README.md new file mode 100644 index 0000000..12ee9ca --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Mais informações + + Para mais informações visite nossa página clicando + [aqui!](http:\\vlibrasplayer.lavid.ufpb.br) + + + +@mainpage Documentação VLibras Desktop +# Overview + Este documento tem como principal objetivo, oferecer uma visão simples da arquitetura do +software VLibras desktop, versão Windows, para melhor entendimento do seu funcionamento. + + +Como Ilustrado na figura abaixo, o player utiliza as funcionalidades do plugin, são elas: + +1. coreInitialize +2. coreExecute +3. coreFinalize + +O plugin é uma biblioteca de ligação dinâmica (dll), responsável por fazer a comunicação +entre o sistema operacional e o tradutor, e entre o tradutor e o player. Para fazer essa comunicação +ele utiliza as classes PyTradutor e PyClip, que são implementadas na linguagem C++. +Essas classes importam a lib python.h para ter acesso aos módulos de +tradução(PortGlosa.py) e clipboard(Clipboard.py) implementados na linguagem Python. +Os executáveis Bdrag e hunpos-tag servem para fazer a cópia automática da seleção do +mouse para área de transferência do sistema operacional e classificar as palavras do texto +selecionado, respectivamente. + +![overview](..\..\workflow\visao geral da arquitetura.png) + + +# CoreInitialize + + +Esse método apenas instancia os objetos da classe PyTradutor e PyClip, e inicializa a +aplicação Bdrag que permanecerá executando durante toda a execução do VLibras. + + + +![overview](..\..\workflow\coreInitialize.png) + + + +# CoreExecute + +Esse método é responsável por: +1. Copiar a área de transferência para uma variável que será usada na tradução +2. Traduzir o texto selecionado de português para glosa +3. Enviar a glosa para o player para que ele possa importar e interpolar as animações + +![overview](..\..\workflow\coreExecute.png) + + +# coreFinalize + + +Esse método apenas finaliza as instancias criadas e encerra a aplicação Bdrag. + + +![overview](..\..\workflow\coreFinalize.png) \ No newline at end of file diff --git a/doc_config b/doc_config new file mode 100644 index 0000000..6c4fc36 --- /dev/null +++ b/doc_config @@ -0,0 +1,367 @@ +# Doxyfile 1.8.9.1 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = "VLibras Desktop Windows" +PROJECT_NUMBER = beta +PROJECT_BRIEF = "Traduçao de Português para LIBRAS" +PROJECT_LOGO = C:/Users/bruno/Desktop/user_install/icons/icon_vlibras.ico +OUTPUT_DIRECTORY = C:/Users/bruno/vlibras-core-win/doc +CREATE_SUBDIRS = NO +ALLOW_UNICODE_NAMES = NO +OUTPUT_LANGUAGE = Brazilian +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 4 +ALIASES = +TCL_SUBST = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +AUTOLINK_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO +TYPEDEF_HIDES_STRUCT = NO +LOOKUP_CACHE_SIZE = 0 +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = NO +EXTRACT_PRIVATE = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = NO +HIDE_SCOPE_NAMES = NO +HIDE_COMPOUND_REFERENCE= NO +SHOW_INCLUDE_FILES = YES +SHOW_GROUPED_MEMB_INC = NO +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = src\ include\ plugin\ README.md +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.f90 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.as \ + *.js +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = * +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +USE_MDFILE_AS_MAINPAGE = +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +SOURCE_TOOLTIPS = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +CLANG_ASSISTED_PARSING = NO +CLANG_OPTIONS = +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_INDEX_NUM_ENTRIES = 100 +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "Doxygen generated docs" +DOCSET_BUNDLE_ID = org.doxygen.Project +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.doxygen.Project +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.doxygen.Project +DISABLE_INDEX = NO +GENERATE_TREEVIEW = NO +ENUM_VALUES_PER_LINE = 4 +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +USE_MATHJAX = NO +MATHJAX_FORMAT = HTML-CSS +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest +MATHJAX_EXTENSIONS = +MATHJAX_CODEFILE = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO +EXTERNAL_SEARCH = NO +SEARCHENGINE_URL = +SEARCHDATA_FILE = searchdata.xml +EXTERNAL_SEARCH_ID = +EXTRA_SEARCH_MAPPINGS = +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4 +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +LATEX_EXTRA_STYLESHEET = +LATEX_EXTRA_FILES = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO +LATEX_BIB_STYLE = plain +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +RTF_SOURCE_CODE = NO +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_SUBDIR = +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- +GENERATE_DOCBOOK = NO +DOCBOOK_OUTPUT = docbook +DOCBOOK_PROGRAMLISTING = NO +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +EXTERNAL_PAGES = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = NO +MSCGEN_PATH = +DIA_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = NO +DOT_NUM_THREADS = 0 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = +DIAFILE_DIRS = +PLANTUML_JAR_PATH = +PLANTUML_INCLUDE_PATH = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES diff --git a/include/pyClip.h b/include/pyClip.h index 4396369..dea9a87 100644 --- a/include/pyClip.h +++ b/include/pyClip.h @@ -1,14 +1,15 @@ //***************************************************************** /* -VLibras: Automatic contents translator from Portuguese to LIBRAS +VLibras: Tradução de Português para LIBRAS -Copyright (c) 2015 Bruno santos -VLibras-Core group at LAViD, Federal University of Paraiba +Bruno santos +VLibras-Core +2015 */ //***************************************************************** /** -* \file pyClip.cpp +* \file pyClip.h * \authors Bruno Santos * \date Janeiro 2015 */ @@ -18,6 +19,11 @@ VLibras-Core group at LAViD, Federal University of Paraiba #include "Python.h" +/** \brief Classe para copiar área de Transferência do sistema operacional. +* +* Essa classe permite copiar todo conteúdo salvo na área de transferência do sistema operacional, +* permitindo sua utilização numa aplicação C++. +*/ class PyClip { private: @@ -30,11 +36,42 @@ class PyClip PyObject * pArgs; PyObject * pResult; public: - PyClip(); - ~PyClip(); - char* clip(); - void bdragOn(); - void bdragOff(); + +/** \brief O construtor da classe. +* +* O construtor inicia o ambiente Python para copiar os textos salvos na área de transferência do sistema operacional. +*/ + PyClip(); + +/** \brief O Destrutor da classe. +* +* O Destrutor finaliza o ambiente Python montado para execução da cópia. +*/ + ~PyClip(); + +/** \brief Cópia da área de Transferência. +* +* Esse método permite copiar o conteúdo da área de Transferência. +* \param void +* \return Ponteiro para char com o texto copiado, caso o conteúdo copiado não seja texto, exibe a mensagem: "ESCOLHER TEXTO CERTO". +*/ + char* clip(); + +/** \brief Inicia Bdrag +* +* Esse método inicia a aplicação Bdrag, que é responsável por copiar a seleção do mouse automaticamente para área de transferência. +* \param void +* \return void +*/ + void bdragOn(); + +/** \brief Finaliza Bdrag +* +* Esse método finaliza a aplicação Bdrag, que é responsável por copiar a seleção do mouse automaticamente para área de transferência. +* \param void +* \return void +*/ + void bdragOff(); }; #endif diff --git a/plugin/corePlugin.h b/plugin/corePlugin.h index cdc8f35..847ff7e 100644 --- a/plugin/corePlugin.h +++ b/plugin/corePlugin.h @@ -1,3 +1,18 @@ +//***************************************************************** +/* +VLibras: Plugin para integração com Unity + +Bruno santos +VLibras-Core +2015 +*/ +//***************************************************************** + +/** +* \file corePlugin.h +* \authors Bruno Santos +* \date Janeiro 2015 +*/ #ifndef _COREPLUGIN_H #define _COREPLUGIN_H diff --git a/workflow/coreExecute.png b/workflow/coreExecute.png new file mode 100644 index 0000000..767ddd5 Binary files /dev/null and b/workflow/coreExecute.png differ diff --git a/workflow/coreFinalize.png b/workflow/coreFinalize.png new file mode 100644 index 0000000..6d78106 Binary files /dev/null and b/workflow/coreFinalize.png differ diff --git a/workflow/coreInitialize.png b/workflow/coreInitialize.png new file mode 100644 index 0000000..8682020 Binary files /dev/null and b/workflow/coreInitialize.png differ diff --git a/workflow/icon_vlibras.ico b/workflow/icon_vlibras.ico new file mode 100644 index 0000000..ee9aefe Binary files /dev/null and b/workflow/icon_vlibras.ico differ diff --git a/workflow/visao geral da arquitetura.png b/workflow/visao geral da arquitetura.png new file mode 100644 index 0000000..3017cb0 Binary files /dev/null and b/workflow/visao geral da arquitetura.png differ -- libgit2 0.21.2