Skip to content

Test documentation #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonatansve merged 2 commits into from
Sep 5, 2013
Merged

Test documentation #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9df788b
Updated cmd-line documentation so that table is shown and deleted old…
jonatansve Sep 5, 2013
30f775e
Documentation polish
jonatansve Sep 5, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cmdline-app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Arguments of the application
.............................

The application can validate one image or compare two images.

========================= ===== ===================================================================================
Argument Description
========================= ===== ===================================================================================
--save-report -s Save report into file with the same name and with extension drep
Expand Down
126 changes: 0 additions & 126 deletions docs/cmdline-app.rst.orig
View file
Open in desktop

This file was deleted.

101 changes: 0 additions & 101 deletions docs/important_parts.rst
View file
Open in desktop

This file was deleted.

14 changes: 5 additions & 9 deletions docs/source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ General Source Code Information
------------------------------------------------------------

Differ is split into three different packages. The differ-cmdline package is used to run differ in a command line environment with export in plaintext and drep (xml) format. The differ-webapp package creates a graphical web interface for the application. The differ-common package holds all classes and resources used by both applications to extract metadata and display it.

Each extractor tool is run with preset arguments and exported to XML. The application then transforms this data with regexp or xslt and maps it to defined properties.

Transformers of external program output
Transformers of output from external programs
......................

Main application context is
Expand All @@ -28,7 +28,7 @@ At the end of transformation, some values are normalized with these classes (def
Metadata
......................

Structure that hold all informations being extracted from all external image metadata extractors is
Structure that hold all informations being extracted from all external image metadata extractors

https://github.com/Differ-GSOC/differ/blob/master/differ-common/src/main/java/cz/nkp/differ/compare/io/ImageProcessorResult.java

Expand Down Expand Up @@ -57,11 +57,7 @@ Text report output and various formating classes
Web application
......................

Configurations

https://github.com/jstavel/differ/tree/master/differ-webapp/src/main/resources

Main sources for a web application
Main source for web application

https://github.com/jstavel/differ/tree/master/differ-webapp/src/main/java/cz/nkp/differ

Expand All @@ -70,7 +66,7 @@ Main sources for a web application
Documentation
......................

Documentations is written using Sphinx
Documentation is written using Sphinx

https://github.com/jstavel/differ/tree/master/docs

Expand Down