Reader small image

You're reading from  Getting Started with Lazarus IDE

Product typeBook
Published inFeb 2013
Reading LevelIntermediate
PublisherPackt
ISBN-139781782163404
Edition1st Edition
Languages
Tools
Right arrow
Author (1)
Roderick Person
Roderick Person
author image
Roderick Person

Roderick Person has a varied background in the corporate IT field. For the last 14 years he has been a programmer for one of the top ranked health systems in the United States. He is experienced with developing applications in Delphi, Free Pascal, Python, SQL, and other languages. He is also an advocate of leveraging open source applications in corporate environments.
Read more about Roderick Person

Right arrow

Summary


In this chapter we learned how to document our source code using the Lazarus Documentation Editor tool, LazDE.

We built the LazDE tool, noting that, if doing so on Linux, we may have problems unless we copy the source to a new directory, change permissions, or build the project using the root account.

We opened the existing Lazarus documentation file for the TButton unit and examined the TBitBtn class. We saw that nodes in the element listing that contain existing documentation can be identified by their icons. We looked at the different fields for providing descriptions of classes or methods, listing possible errors raised, and linking classes or methods to one another.

We created documentation for the DRU project form we created in Chapter 4, Converting a Delphi Program, by adding documentation to the procedure called when clicking on the Run button and briefly documenting the Run button itself. Then, we built the documentation as HTML files and opened the output in a browser.

Finally...

lock icon
The rest of the page is locked
Previous PageNext Chapter
You have been reading a chapter from
Getting Started with Lazarus IDE
Published in: Feb 2013Publisher: PacktISBN-13: 9781782163404

Author (1)

author image
Roderick Person

Roderick Person has a varied background in the corporate IT field. For the last 14 years he has been a programmer for one of the top ranked health systems in the United States. He is experienced with developing applications in Delphi, Free Pascal, Python, SQL, and other languages. He is also an advocate of leveraging open source applications in corporate environments.
Read more about Roderick Person