Recent

Author Topic: Undocumented unit compwriterpas.pas in LazUtils  (Read 421 times)

dsiders

  • Sr. Member
  • ****
  • Posts: 370
Undocumented unit compwriterpas.pas in LazUtils
« on: March 22, 2020, 05:25:15 am »
There is a unit in the LazUtils package without a documentation file: compwriterpas.pas.

I created a skeleton for it, but quickly realized I don't have the knowledge needed to properly document the unit.

Should I submit the mostly undocumented FPDoc template file to Mantis? Perhaps someone with a better understanding of the subject could fill in the blanks.

Just curious...

Thanks,

Don
Lazarus 2.1 (SVN) / FPC 3.0.4 / FPC 3.2.0 / x86-win64 / Windows 8.1

eljo

  • Sr. Member
  • ****
  • Posts: 408
Re: Undocumented unit compwriterpas.pas in LazUtils
« Reply #1 on: March 22, 2020, 07:05:54 am »
from a quick look around it seems like a proxy over the streaming framework for the objects that instead of saving the properties and their values it saves code to create the component at runtime and assign the values to the properties. I do not think there is something more to document perhaps an example or two that replace begin signature and end signature with some sort of procedure and end; to demonstrate the complete package but other than that the documentation for the streaming capabilities should be enough.

 

TinyPortal © 2005-2018