Recent

« previous next »
Pages: [1]

Author Topic: Add comments to properties  (Read 774 times)

Marion

  • Full Member
  • ***
  • Posts: 116
Add comments to properties
« on: May 06, 2023, 05:46:03 am »
I am writing a custom component. In the IDE, some component properties display a description at the bottom of the Object Inspector. I'm trying to figure out how to do that in my component but I can't find anything on it.
Logged
Thank you,
Marion
(A recovering Windows programmer.)

Blaazen

  • Hero Member
  • *****
  • Posts: 3235
  • POKE 54296,15
    • Eye-Candy Controls
Re: Add comments to properties
« Reply #1 on: May 06, 2023, 06:12:58 am »
It's taken from file ..lazarus/doc/xml/lcl/controls.xml and it's done with FPDoc Editor which is part of IDE (menu View). You can do it for your package too.
Logged
Lazarus 2.3.0 (rev main-2_3-2863...) FPC 3.3.1 x86_64-linux-qt Chakra, Qt 4.8.7/5.13.2, Plasma 5.17.3
Lazarus 1.8.2 r57369 FPC 3.0.4 i386-win32-win32/win64 Wine 3.21

Try Eye-Candy Controls: https://sourceforge.net/projects/eccontrols/files/

bobby100

  • Full Member
  • ***
  • Posts: 156
    • Malzilla
Re: Add comments to properties
« Reply #2 on: May 06, 2023, 03:17:17 pm »
Write description as comment, one line above the property/method declaration in your unit.
Logged
https://gitlab.com/bobby100 - my Lazarus components and units
https://sourceforge.net/u/boban_spasic/profile/ - my open source apps

https://malzilla.org/ - remainder at my previous life as a web security expert

Blaazen

  • Hero Member
  • *****
  • Posts: 3235
  • POKE 54296,15
    • Eye-Candy Controls
Re: Add comments to properties
« Reply #3 on: May 06, 2023, 03:31:17 pm »
Those comments one line above appear as a hint when you hover the identifier in Source Editor. I'm just not sure if they also appear in Object Inspector.
Logged
Lazarus 2.3.0 (rev main-2_3-2863...) FPC 3.3.1 x86_64-linux-qt Chakra, Qt 4.8.7/5.13.2, Plasma 5.17.3
Lazarus 1.8.2 r57369 FPC 3.0.4 i386-win32-win32/win64 Wine 3.21

Try Eye-Candy Controls: https://sourceforge.net/projects/eccontrols/files/

Marion

  • Full Member
  • ***
  • Posts: 116
Re: Add comments to properties
« Reply #4 on: May 08, 2023, 10:57:13 pm »
Quote from: bobby100 on May 06, 2023, 03:17:17 pm
Write description as comment, one line above the property/method declaration in your unit.

Thank you.
Logged
Thank you,
Marion
(A recovering Windows programmer.)
Pages: [1]
« previous next »
 

TinyPortal © 2005-2018