[Lazarus] Refactor -> Rename Identifier and fpdoc documentation
Michael Van Canneyt
michael at freepascal.org
Tue Aug 5 09:01:51 CEST 2008
On Fri, 1 Aug 2008, Graeme Geldenhuys wrote:
> Hi,
>
> I'm not sure if this has already been implemented or asked for as a
> feature request.
>
> It's pretty awesome having the fpdoc editor inside the IDE. It makes
> documentation a much more convenient task. Now I know refactoring
> doesn't occur too often on established/documented code, but could it
> be integrated with the documentation. So that if you rename an
> identifier in the code, it will update the fpdoc documentation as well
> (if it exists). For example, renaming a class, or even renaming a
> method by fixing a spelling mistake that slipped through.
>
> At the moment it's a tedious tasks to update the fpdoc xml files after
> a code refactor. Currently it's a manual task by using Search &
> Replace in all appropriate xml files. A automated process would be a
> wonderful help.
Maybe it would be a good thing to have a unit fpdocutils which
has a couple of routines for this. After all, it's just walking
through the XML tree, and changing a few selected tags and/or
attributes. This could then be used in a command-line utility,
and in the Lazarus editor.
I'll add it to my todo list.
Michael.
More information about the Lazarus
mailing list