|
From: silvioprog <sil...@gm...> - 2015-06-11 20:20:14
|
On Tue, Jun 9, 2015 at 1:33 AM, Michalis Kamburelis <
mic...@gm...> wrote:
> silvioprog wrote:
> > On Mon, Jun 8, 2015 at 9:31 PM, silvioprog <sil...@gm...
> > <mailto:sil...@gm...>> wrote:
> >
> > Hello,
> >
> > I have a structure like this:
> >
> > { This class provides some features blah blah blah... }
> > TSomeClass = class abstract(TObject)
> > public
> > { This method executes blah blah blah... }
> > procedure SomeMethod; virtual; abstract;
> > end;
> >
> > TOtherClass = class(TSomeClass)
> > public
> > { <<< what I put here? >>> }
> > procedure SomeMethod; override;
> > end;
> >
> > I.e, in TOtherClass I need to override the comment "This method
> > executes blah blah blah..." from the TBaseClass class.
> >
> > How to do that? Is it possible in current released PasDoc?
> >
> > Thank you!
> >
> >
> > Oh, I found this link:
> >
> > https://sourceforge.net/p/pasdoc/patches/4/
> >
> > Is this (nice) feature implemented in PasDoc 0.13.0?
> >
> > Thank you!
> >
>
> The feature from https://sourceforge.net/p/pasdoc/patches/4/ is not
> implemented. The patch in https://sourceforge.net/p/pasdoc/patches/4/
> waits for someone to contribute time and actually apply it on top of new
> pasdoc sources.
>
Hm... is this patch compatible with actual PasDoc sources on trunk? This is
really a great feature because it identifies what's API/interface and
what's implementation, the guys use it in Java/C#.
> There is no feature to *automatically inherit* method descriptions now.
> In case of class descriptions, the ancestor description will be
> automatically shown in case the descendant class is missing. But in case
> of methods, no such thing happens automatically. That said, you can use
> http://pasdoc.sipsolutions.net/InheritedClassnameNameTag like this:
>
> TOtherClass = class(TSomeClass)
> public
> { See @inherited for description. }
> procedure SomeMethod; override;
> end;
>
> This will insert an explicit link to ancestor.
>
I saw, and it is a very nice feature too. I'll use that. =)
> Other than this, you can just manually copy description from abstract
> SomeMethod to overridden SomeMethod. It's hardly a nice solution, but it
> will work without any problems of course:)
>
Oops, no, because it can duplicates the comments, and I need to unify it in
an one place.
Thank you!
--
Silvio Clécio
My public projects - github.com/silvioprog
|