Report Features Overview|
|Multi programming language|
There is no hard coded programming language limitation on the source code that can be processed by Universal Report. Most of common programming
languages are covered including Ada, Assembler, Basic, Borland C++ Builder, Borland C# Builder, Borland Delphi,
Maple, Mathematica, Microsoft Visual Basic, Microsoft Visual Basic .Net, Microsoft Visual C#, Microsoft Visual C++,
Microsoft Visual C++ .Net, Microsoft Visual FoxPro, Microsoft Visual J++, Pascal, Perl, Php, PL1, Python, VHDL, Other (for
non listed ones).
|Several output formats|
The output documentation can be in html, plain text, or latex
. However, html
format is the
most mature and featured. Important features available in the html report includes:
| a search script that looks for text over the entire documentation. |
| an online commenting system that allows to post a global review for a any routine. |
| an online annotation system that allows to insert local comments within the body of any routine.|
| a dynamic flowchart mode that makes each block of a routine to be collapsed and expanded.|
| a routines call graph from each routine (forward and backward).|
| a detailed analysis and dynamic decomposition of each routine.|
| a switch [hide/display] for comment lines and blank lines.|
| the management of special comment tags (input, output, purpose, example, any user defined tag).|
| an automatic screenshots from form files (VB, Delphi, C++ Builder, Kylix, Ressource files, etc...) .|
Since Universal Report is not dedicated to a specific programming language and can document a mixed source code, there is a possibility
to document a source code without any prior technical information. In that case, Universal Report will attempt to automatically detect
extract crucial information and either continue with the documentation process or prompt on the next step of the wizard.
Universal Report can perform several independent documentation tasks at a time, regardless of the programming languages involved
and the input/output locations. In such case, it produces a unified html index page that gives access to each
of the generated documentations.
Universal Report can read database files and generates a detailed report of the structure and elements (tables, fields, attributes).
|Automatic dowload and upload|
The path of the input files to be documented could be a web location. In that case, Universal Report will make and inventory of the
matching files and download them into the local disk and proceed from it. In the other hand, there is an option to automatically upload
the generated documentation to a web server.
|Two way of achieving a documentation session|
A documentation session can be achieved either by starting from scratch using the wizard or the direct report feature, or from a
.urp file. A .urp file is generated each time a documentation task (started from scratch) is accomplished. It contains the input/output information,
the elements of the code, and all parameters and preferences. Next time the same source needs to be documented, processing from its
.urp file is possible more convenient. If there are new files, Universal Report will automatically detect them and will propose
to include or ignore them.
UDIFF is a file differencing tool that compares two files and reports the differences (lines added, lines changed, lines suppressed) and
highlights the changes. The output has a convenient layout and is dynamic (each part can be made visible or hidden). This tool is standalone and is also part
of Universal Report full distributions.
|Changes analysis and reporting|
When the source code has changed, documenting from the previous .urp automatically activates the changes analysis routine of
Universal Report. This result in a detailed analysis of all changes (quantitative and qualitative), which is included as part of the
|Fast and robust processing|
Universal Report uses state-of-the-art algorithms to parse the source code and analyze its elements. The process is quiet fast
and robust. There is also a possibility to start browsing the report while it is being updated from the documentation task.
|Highly optimized output|
The ouput documentation produced by Universal Report is highly optimized by a state-of-the-art html encoding and
trought an intranet.
The html page of each routine contains some features that apply on the formatted code in order to produce a specific layout or transformation. One of these if the FlowChart generation, which is generated and displayed from the hmtl report.
|Trace/Bug handling and Live Update|
There is an option that activates an automatic tracing system. In that case, each step is recorded from the wizard to the main execution
of the documentation. The resulting directory with information that can help to quickly identify and fix any abnormal behavior. There is a
local system that allows to send a bug notification. Moreover, there is a live update system for any Universal Report installation.
|Translation of user comments|
Comments written inside the code can now be translated into a desired language using the Google translator engine. Universal Report (from version 10.0) offers this feature directely from the documentation, just have to click on a comment line or paragraph to open a translation dialog box.
|What's new with version 10.0|