ImageEn for Delphi and C++ Builder ImageEn for Delphi and C++ Builder

 

ImageEn Forum
Profile    Join    Active Topics    Forum FAQ    Search this forumSearch
Forum membership is Free!  Click Join to sign-up
Username:
 Password:
Save Password
Forgot your Password?

 All Forums
 ImageEn Library for Delphi, C++ and .Net
 ImageEn and IEvolution Support Forum
 Compact declaration vs. Self-documenting declaration		  New Topic  Reply to Topic
Author Previous Topic Topic Next Topic  

PeterPanino

994 Posts
Posted - Sep 14 2025 :  15:10:37  Show Profile  Reply
Dear Nigel, in the CHM documentation you use a COMPACT declaration, e.g.:

function ImportFromFileSVG(const FileName: WideString; Width: Integer = -1; Height: Integer = -1; MaintainAR: Boolean = False): Boolean;

Please use a Self-documenting declaration type instead. For example:



This is much clearer, and the user doesn't need to consult separate text paragraphs to understand the parameters.

xequte

39146 Posts
Posted - Sep 15 2025 :  00:29:13  Show Profile  Reply
Hi Peter

I think everyone has their preferred style for declarations. The one above is quite useful for complex methods with lots of parameters, and a similar style appears in the documentation in a few places. I'll consider more use of it going forward.

Nigel
Xequte Software
www.imageen.com
Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
Jump To: