diff --git a/Doxyfile b/Doxyfile index b26ca0e..71d116f 100755 --- a/Doxyfile +++ b/Doxyfile @@ -38,7 +38,7 @@ PROJECT_NAME = playuver # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.1 +PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -51,7 +51,7 @@ PROJECT_BRIEF = # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = resources/playuver.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -68,7 +68,7 @@ OUTPUT_DIRECTORY = doc # performance problems for the file system. # The default value is: NO. -CREATE_SUBDIRS = NO +CREATE_SUBDIRS = YES # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this @@ -152,7 +152,7 @@ FULL_PATH_NAMES = YES # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = /home/lucas +STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which @@ -242,7 +242,7 @@ TCL_SUBST = # members will be omitted, etc. # The default value is: NO. -OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored @@ -502,7 +502,7 @@ CASE_SENSE_NAMES = YES # scope will be hidden. # The default value is: NO. -HIDE_SCOPE_NAMES = NO +HIDE_SCOPE_NAMES = YES # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. @@ -743,7 +743,7 @@ WARN_LOGFILE = # spaces. # Note: If this tag is empty the current directory is searched. -INPUT = source +INPUT = # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -826,7 +826,9 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = build \ + doc \ + external # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/Mainpage.dox b/Mainpage.dox old mode 100755 new mode 100644 index 85b9b9a..50c93fd --- a/Mainpage.dox +++ b/Mainpage.dox @@ -1,6 +1,43 @@ /** @mainpage plaYUVer Application -plaYUVer - open source raw video player +Description +---------------------------------------------------------------- + +plaYUVer is an open-source video player with the following features: +- support for libavformat and libavcodec; +- support for wide range of raw video formats; +- advanced frame zoom with easy to use pan function +- usefull information in status bar, *e.g.*, pixel information +- API for frame processing algorithms + + +Developers +---------------------------------------------------------------- + +- Joao Carreira (jfmcarreira@gmail.com) +- Luis Lucas (luisfrlucas@gmail.com) + + +Install using cmake +---------------------------------------------------------------- + +1. The following are required for compilation: + - an ordinary C++ development environment (g++, make, C++ libraries and headers, ...) + - cmake + - a Qt development environment (libraries, headers, qmake, ...): only QtCore, QtGui and QtWidgets are required, at least in version 4 + +2. Dependencies: + - QT + - FFmpeg (optional) + - OpenCv (optional) + +3. Run the following commands: (this will create an executable named playuver) +``` +mkdir build +cd build +cmake ../ +make +``` */