Documentation Insight Express has been released with RAD Studio XE2

Written by Baoquan Zuo on . Posted in Announcements

Documentation Insight Express is a FREE edition distributed with Embarcadero RAD Studio XE2 or higher. It supports most basic features to benefit common Delphi Developers. We also provide Professional and Enterprise editions to fulfill your professional requirements.

To compare the different editions, please visit:

Feature Matrix

To get more information, please visit http://www.devjetsoftware.com/products/documentation-insight/

A Free DI license for A Better Slogan

Written by Baoquan Zuo on . Posted in Announcements

Documentation Insight is the most powerful documentation add-in in the Delphi IDE. By its impressive WYSIWYG editor, you will be able to visually read your documentation in the source code and naturally write xml documentation.

NOW, we offer an opportunity to get a FREE license of the product if you could give us an Impressive slogan. You just need to leave your slogan as the comment of this post. We will choose a satisfied one.

Due Date: Jun 30th, 2011

Updated on Jun 11th, 2011: We have decided to Offer 3 FREE licenses for the Top Three slogans that will be determined by our team.

Updated on July 1st, 2011: This activity has been finished. The final winner list will be available in one week.

Note: The final decision will be made by ourselves.

DevJET Software

FREE Documentation Insight licenses for Active Open Source Projects

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

There are so many good open source projects in the Delphi community and most of us can benefit from them. However, it often appears that we are not sure about the usage of a class, a method or a parameter as they are not documented in the source code.

Documentation Insight is a powerful documentation tool which can help us visually read and write documentation in the IDE. Many users are very pleased with it. We think it will be great if more and more open source projects are well documented. So if you are the author or one of major comitters of an active open source project, you may have an opportunity to get a FREE license of Documentation Insight.

Note: The donated license should be used for non-commericial use in principle but you can get a BIG discount if you wanna order it for commercial use.

To get more information on Documentation Insight, please visit the Product page:

Email: support@devjetsoftware.com

Documentation Insight Beta 2 Released

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

Updated: Documentation Insight has shipped, please visit the product page.

1. Introduction

Documentation Insight is an add-in for RAD Studio IDE and it provides a WYSIWYG editor to help you visually view and edit xml documentation.

2. Requirements

  • Internet Explorer 7 or higher
  • MSXML 6.0
  • RAD Studio 2007/2010/XE (Delphi)

3. What’s new in Beta 2

+ Integrate with VCL help documentation (Preview).

+ More region styles (Customizable Caption or summary snippet).

+ Added a Shortcut Key (It’s Ctrl+Shift+D by default) to show/hide DI.

+ Added an option to insert line break before documentation to make code look beautiful.

+ Added an menu to explore syntax parser logs

* All unknown section tags will be reserved when saving documentation.

* Find nearest code element in the forward direction. (Interface section)

# Bug Fixes:

  • AV exception raised when closing a model view.
  • Option: Minimum lines of documentation (Thanks to Tygrys)
  • Parameters/Typeparameters missed when the count of the <param>/<typeparam> tags are mismatched from declared (Thanks to John Kaster)
  • Some Syntax Parser bug fixes

4. Download

Updated: This beta is not available, Please download the latest version from the Downloads page.)

5. Additional Information

Here is a snapshot to demonstrate the integration with VCL help documentation (Delphi XE). Enjoy it!

Note: You need to make sure that your local VCL help documentation has been correctly installed in order to try this feature. Documentation Insight just extracts necessary information from local help, the copyright of the contents belongs to Embarcadero.


Delphi Documentation Guidelines

Written by Baoquan Zuo on . Posted in Announcements

1. Preface:

When we want to learn a code library, we must read its documentation at first. A professional documentation will help us easily get the key points and understand the design intention of the author. It is no doubtful that one of the most impressive examples is MSDN.

On the other hand, when we play the role of an author, we also need to write documentation to explain our code and design remarks, especially when working together with other developers.

2. Introduction:

Delphi Documentation Guidelines has 23 pages. It targets the XML Documentation and tells you how to write xml documentation for your code. It also provides detailed XML tag reference, examples and examples out (snapshot).

3. Table of Contents:

Here lists the Table of Contents of the document:

Table of Contents

1. Copyright 3

2. Acknowledgements 3

3. Revision History 3

4. Overview 4

5. XML Documentation 5

5.1 Introduction 5

5.2 Section Tags 6

5.3 Block Tags 6

5.4 Inline Tags 7

5.5 Tag Usage 7

6. XML Tag Reference 7

6.1 <c> 7

6.2 <code> 8

6.3 <example> 8

6.4 <exception> 9

6.5 <include> 10

6.6 <list> 10

6.7 <note> 12

6.8 <para> 13

6.9 <param> 14

6.10 <paramref> 14

6.11 <permission> 15

6.12 <preliminary> 15

6.13 <remarks> 15

6.14 <returns> 16

6.15 <see> 16

6.16 <seealso> 16

6.17 <summary> 17

6.18 <threadsafety> 18

6.19 <typeparam> 18

6.20 <typeparamref> 19

6.21 <value> 19

7. Write Documentation 21

8. Generate Documentation 23

9. References 23

4. Download:

http://www.devjetsoftware.com/downloads/Delphi-Documentation-Guidelines.pdf

This is the initial release. Please feel free to download it. I hope that you can understand xml documentation better with this document.

If there is anything missed or wrong, please let me know.

Documentation Insight Beta 1 Released

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

Updated: Documentation Insight has shipped, please visit the product page.

We are very excited to announce that the first beta of Documentation Insight is now released!

1. Introduction

Documentation Insight is an add-in for the RAD Studio IDE and it provides a WYSIWYG editor to help you visually view and edit xml documentation.  Here are some snapshots of the product:

Snapshot1: Reading Mode (Navigation)

Snapshot 2: Editing mode

With Documentation Insight, you can easily bold/italic/underline/strikethrough text, start a bulleted list, a numbered list or a definition table, or insert an image, a hyper link, a code snippet or a note block, etc. And Documentation Insight will automatically generate xml documentation and update the source code in a second.

It’s so wonderful since you don’t have to remember the complicated syntax and deal with messy xml tags.

2. Environment Requirements:

  • Internet Explorer 7 or higher
  • MSXML 6.0
  • RAD Studio 2007/2010/XE

3.Download:

[Closed]

Note: This version is intended to preview and test. It will be expired on Oct. 31th, 2010. We’ll release a new version before it has been expired. Please see the Release Notes and the Help in the application folder.

P.S. We just released Delphi Documentation Guidelines. You must not miss it : ^)

Rename It!RC1 Released

Written by Baoquan Zuo on . Posted in Announcements, Products

We are happy to announce that Rename It! RC1 is released now!

1. Introduction

You must love this wizard if you like refactoring. It can help you quickly rename a unit and update all references in the specified scope such as the current project group.

In the earlier IDEs such as Delphi 7, insteading of using the “Save AS” feature, you just need one click to enter a new name and the refactoring will be finished in a second. In the newer IDEs such as Delphi 2007, you will be notified when a module was renamed in the project manager and the refactoring can be performed automatically.

Furthermore, the old module files and its corresponding .dcu file could be automatically deleted if exist.

2. Requirements

Supported IDEs: Delphi 7, RAD Studio 2007/2010/XE

3. Download

Note: This version is for preview purpose, it will be expired on Oct. 31th, 2010. We will release the final version in weeks.

For more information on Rename It!, please read the User Manual in the product.

Any ideas or questions, please leave a comment or post a thread on our support forums.

Updated 2010-10-30: We have extended the expiration date to Nov 15th, 2010, Please download it again. Sorry for the inconvenience.

Strategic Partnership with CnPack

Written by Baoquan Zuo on . Posted in Announcements

It’s our honor that we have built Strategic Partnership with CnPack.

CnPack is a well-known open source organization in the Delphi community. The team is made up of Chinese Programmers and Delphi / C++ Builder fans across the Internet. Their products include CnWizards, CnVCL, CVSTracNT and etc. All of them are Open Source and Free.

CnPack IDE Wizards (CnWizards) is a Free Plug-in Tool Set for Delphi/C++ Builder/CodeGear RAD Studio to Improve Development Efficiency. For main functions see Screen Snap.

CnPack Component Package (CnVCL) includes non-visual, UI, Net Comm and Multi-Language Components in Delphi / C++ Builder. (Under development).

CVSTracNTCVSTrac for Windows, was migrated and is maintained by the CnPack Team. It is a A Web-Based Bug And Patch-Set Tracking System for CVS under Windows. The original version was developed by D. Richard Hipp.