ANN: Documentation Insight Update V3.3.6.9

Written by Baoquan Zuo on . Posted in Documentation Insight

Documentation Insight minor update V3.3.6.9 fixed the following issues:

  • Fixed error ‘Invalid source array’ for UTF8 files (REGRESSION)
  • Fixed error ‘No member declaration found for the symbol.’ in SysUtils.pas
  • Fixed “Catastrophic error” in System.pas

Download:
http://www.devjetsoftware.com/downloads/DocInsight_Setup_V3.3.6.9.exe

If you have any problems about the version, please let us know.

P.S. To get early Beta Access at first time, please join our online Google Plus Community.

ANN: Documentation Insight 3.2.9.7 Released (Support XE7)

Written by Baoquan Zuo on . Posted in Documentation Insight, News

We have released an update of Documentation Insight 3 with XE7 support and some improvements.

Documentation Insight V3.2.9.7
Added: Support RAD Studio XE7
Added: Support IE8
Improved: reghelp.exe now finds h2reg.exe in both local machine & current user
Improved: Sort units and other code elements in Table Of Contents by name
Improved: DocInsight.exe can now run without requesting Administrator permission
Fixed: Potential encoding issue in CHM generation
Fixed: reghelp.exe may fail to create process in some cases

ANN: Documentation Insight 3.1.1.10 Released

Written by Baoquan Zuo on . Posted in Documentation Insight

Documentation Insight 3.1.1.10 has been released. This minor version includes a few bug fixes:

Fixed: Region Caption should ignore special characters ‘}’, ‘*)’
Fixed: Line break may be produced in region caption
Fixed: DocEditor shows nothing in Design mode when xmldoc has<exclude /> (IE10+)
Fixed: Some Anti-virus software was sensitive with Reghelp.exe

Download Now

ANN: Documentation Insight V3.0.12.20

Written by Baoquan Zuo on . Posted in Documentation Insight

This minor update V3.0.12.20 includes the following changes:

Added secondary shortcuts for Cut/Copy/Paste(Shift+Del/Ctrl+Insert/Shift+Insert)
A property applied with <event> tag will be also identified as an event
Improved Pasting behaviors (Paste & Paste with Formatting)
Improved StayOnTop behavior of DocExplorer
Fixed a bug where some characters such as ‘<’ missing when pasting

Download
http://www.devjetsoftware.com/downloads/

Documentation Insight 3 Roadmap

Written by Baoquan Zuo on . Posted in Documentation Insight, Products

Documentation Insight is a very popular code documentation solution for Delphi.  The latest version is Documentation Insight 3. To our surprise, more than 90% customers with Documentation Insight Enterprise subscription have renewed their subscriptions before they were expired.

By the coming of the X’mas & New Year, we published the roadmap of Documentation Insight 3. If you have any suggestions, you are welcome to leave comments or write to us (support@devjetsoftware.com).

Disclaimer: This information describes DevJet Software’s general product direction at this time, and should not be relied on in making a licensing decision. The future development, release, pricing and timeing of features and functionality remains at our sole discretion and may be changed at any time without notice.

1. Migration Tools

We have been requested by several users to help them migrate Doc-O-Matic/JavaDoc/Native comments to XMLDoc/Separated Documentation files. This feature is high priority.

2. Consider first-class support for JavaDoc & Native comment styles

3. Add PDF output

4. More tags and more information

Inherited <author>, <version>, <since> tags. Extract platform information, required packages, exports section, component icons, type hierarchies page, etc.

5. Customization of Table Of Contents

Allows you customize project name, the structure of the TableOfContents.

6. Improve the integration with other Help Authoring Software

Access topics/Insert a topic link to a H&M master project.

7. Hyperlinks to RAD Studio library symbols

Resolve symbols of RTL/VCL/FMX etc libraries and produce hyperlinks to online/offline RAD Studio Documentation.

8. Inherited documentation in DocInspector/DocExplorer

9. Insert Hyperlink with Live Search

10. Improve the Spell Checker (Checking spelling ONLY against content editable text)

11. Keep improving the underlying compiler

12. Keep improving the documentation editor & integration

e.g. Easier to change note type, code language, etc.

To discuss our product or get early access to Documentation Insight updates at first time, please join our community:  http://plus.google.com/communities/113012729454639868890

Thanks for your continued support.  May we wish you Merry Christmas and have a wonderful New Year!

Documentation Insight 3 Sneak Preview #2

Written by Baoquan Zuo on . Posted in Documentation Insight

In previous preview, we experienced some brand new features in Documentation Insight 3, such as VS2012 presentation style, Inherited Documentation, Syntax Highlighter, Inheritance Hierarchy, etc. In this one, we will see two parts:

Part 1. Additional features about Documentation Generation.

1. FileName Policy

The new documentation generator supports three policies on file name generation:

* Signature

The generated file name will be basically same as the full name of a symbol.

e.g.  Spring.htm, Spring.IList(T).html

Special Rules:

a) For type parameters,  ’<’, ‘>’  will be replaced with ‘(‘ and ‘)’

b) If a method is not overloaded, its parameter type will not be added to the file name

c) For Operators, metadata name will be used.

* Unique Id

All file names will be random but unique id (like ‘a7ef980f.htm‘). All ids will be persisted into another file which will be loaded next time.

* Auto (Default)

By default,  the Signature policy will be used.  An unique id will be used and saved ONLY when a file name exceeds the max-path.

2. Lazy loading  for TableOfContents in Html

lazy-loading

Online demo:  http://www.devjetsoftware.com/demos/spring4d/

(P.S. you need to clear the browser cache if you have ever visited this url.)

3. Inherited documentation for property overrides

It will be very useful for component writers. for example:

PropertyOverridesSource

Generated doc:

PropertyOverrides

 

Part 2. New general features/improvements

External documentation repository

Documentation Insight 3 allows you to choose external documentation storage to keep source code clean. A fixed repository file (DocInsight.ini) will be placed in your project ROOT folder.

[Repository]
SourceDocsDir=SourceDocs

So no matter how you organized your projects in the directory, all source documentation files, which are organized by units, will be placed in the SourceDocs subfolder. (e.g. Spring.xml, Spring.Collections.xml)

A drawback is that the documentation will not be displayed in the built-in Help Insight feature. More details will be published in later documentation.

Documentation Inspector

* Automatically switch between Code Editor & Documentation Inspector when pressing the hotkey
* Auto focus and switch to design mode when shown

Documentation Explorer

* Document Member Summary

You will be able to document member summary just like enumerated members:

document-member-summary

* Sync with current project group

* Remember window state

* Improve Mouse wheel handling

Hotkeys
* Show Documentation Inspector (Ctrl+Shift+D)
* Show Documentation Explorer (Alt+Shift+N)
* Collapse documentation in the Code Editor (Alft+Shift+C)
* Expand documentation in the Code Editor (Alft+Shift+E)

Update options:
* Enable/Disable Automatic check for updates
* Update channel (Debug or Release)

New Generation Compiler

* Conditional defines (Initial conditional defines)
* Conditional expressions (e.g. {$IF defined(POSIX) and not defined(IOS)})
* Include file  (e.g. {$I jedi.inc})
* Search Paths
* Bug fixes

 

We will announce our Beta news on our Google Plus community, you are welcome to follow us on G+

https://plus.google.com/communities/113012729454639868890