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...