Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Arrow up icon
GO TO TOP
Getting Started with Lazarus IDE

You're reading from   Getting Started with Lazarus IDE Get to grips with the basics of programming, debugging, creating, and documenting projects with the Lazarus IDE

Arrow left icon
Product type Paperback
Published in Feb 2013
Publisher Packt
ISBN-13 9781782163404
Length 116 pages
Edition 1st Edition
Languages
Tools
Arrow right icon
Author (1):
Arrow left icon
Roderick Person Roderick Person
Author Profile Icon Roderick Person
Roderick Person
Arrow right icon
View More author details
Toc

Documenting your code


Now that we have built LazDE and looked at a basic overview of the interface, let's document the code that we have created. Click on the File menu and select New. You will be presented with a dialog as shown in the following screenshot:

Create the new documentation package as follows:

  1. Leave Package name as MyPackage.

  2. Click on the icon after the Input file editbox and browse to the directory that includes the file DRU.pas, which we used previously in Chapter 4, Converting Delphi.

  3. Click on the icon next to the Output file editbox, and select a directory to write to and call the output file MyDoc.xml.

The main application screen will appear and we can now begin documenting our unit. Let's do that by documenting the tBtnRunClick event as follows:

  1. In the Document Structure window, expand all nodes until you reach the last node, titled DRU.

  2. In the Elements for selected node treeview, scroll down and select the tBtnRunClick node.

  3. In the Short description field, enter a brief description...

lock icon The rest of the chapter is locked
Register for a free Packt account to unlock a world of extra content!
A free Packt account unlocks extra newsletters, articles, discounted offers, and much more. Start advancing your knowledge today.
Unlock this book and the full library FREE for 7 days
Get unlimited access to 7000+ expert-authored eBooks and videos courses covering every tech area you can think of
Renews at $19.99/month. Cancel anytime
Banner background image