View unanswered posts | View active topics



Reply to topic  [ 21 posts ]  Go to page 1, 2  Next
[FD4] AsDoc helper plugin 
Author Message
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
Hi everyone

Yesterday I made this little plugin to help me Document my code faster and i though maybe i should share it with you all.
Basically what plugin does is adding 2 shortcuts and auto completion for AsDoc tags.

if you like documenting your code the please check it out and let me know what you think.

------------------
latest Version 1.93
------------------
Download : link
video : link
-------------------

[UPDATE 6]
version 1.93 released.
mostly bug fixes


[UPDATE 5]
version 1.9 released.
Improved template support (AS3 )

[UPDATE 4]
Loads of changes since last version, templates are back, suggestions for quickbuild tags (@mxmlc, @mtasc, @haxe) have been added ,and tons of bugs have been fixed.
I should probably write some kind of documentation for the templates but i dont have the time at the moment so you will just have to look at the default templates as examples.


[UPDATE 3]
I've pretty much rewritten the entire plugin so that you can add/remove and tweak both AsDoc and html tags.

Image Image Image Image


[UPDATE 2]
I've fixed the compatibility issue with beta 2.

note: this version is work in progress so there are a few bugs etc.

[UPDATE]
i have made a few improvements to the plugin, see change log for details.



Code:
------------------
Changes 1.9 -> 1.93
------------------
- Fixed: bug preventing header suggestions
- Fixed: bug causing extra line between docs & methods
- added: Constructor template
------------------
Changes 1.81 -> 1.9
------------------
- added: Header Templates
- Changed: moved all license notice templates to Header Templates.
- added: more Apache  and GNU License notice templates.
- fixed: regex bug(package names triggerd class & interface templates)
------------------
Changes 1.8 -> 1.81
------------------
- fixed: template bug
------------------
Changes 1.76c -> 1.8
------------------
- added: Interface Templates

------------------
Changes 1.76b -> 1.76c
------------------
- change: temporarily workaround for OS specific bug.
------------------
Changes 1.76 -> 1.76b
------------------
- fixed a minor bug
------------------
Changes 1.5 -> 1.76
------------------
- added: Suggestions for quickbuild tags
- added: customizable templates
- added: import/export settings to xml
- added: browse for file option (asDoc tags & quickbuild arguments)
- bug fix: didnt care to count but have fixed tons of bugs :P
------------------
Changes 1.1b -> 1.5
------------------
- changed: plugin rewitten from scratch
- added: customizable tag settings
------------------
Changes 1.1a -> 1.1b (WIP)
------------------
- fixed: compatibility issue (FD beta 2)
- added: support for interfaces
- added: text templates for return (string, boolean)
------------------
Changes 1.1 -> 1.1a
------------------
- Bug Fix: fixed problem with auto-completion of classes

------------------
Changes 1.0 -> 1.1
------------------
- added: auto-complete suggestion for @param
- added: more HTML tags (it now have all the HTML tags that FDT4 has)
- added: tooltip descriptions
- changed: different icons for AsDoc and HTML tags

------------------
Version history 1.0
------------------
- Shortcut for auto generation of function documentation (default: alt + D)
- Shortcut for tag suggestion (default: ctrl + space)
- Autocomplete list for AsDoc tags.


Note: Just to keep things clean, i did not write every piece of code in this plugin, i borrowed and customized a few functions from the ASCompletion that where set to private.

_________________
My plugins : http://m0rkeulv.net/plugins/


Last edited by m0rkeulv on Fri Aug 24, 2012 2:47 pm, edited 15 times in total.



Thu Jul 28, 2011 12:30 am
Profile
Member

Joined: Mon Feb 23, 2009 12:52 am
Posts: 96
Location: France
Reply with quote
FD4b2 R2044 : "unable to load an incompatible plugin" :(


Sat Aug 27, 2011 1:22 am
Profile WWW
Member

Joined: Fri Jul 30, 2010 2:28 am
Posts: 118
Reply with quote
m0rkeulv, could you attach some screenshots to show plugin potentiality?


Sun Aug 28, 2011 6:48 am
Profile
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
Screenshots probably won’t illustrate much as this plug-in is only extending the built-in auto-completion by adding new shortcuts and suggestions.

If you’re interested in how it works, I've posted a video demonstration here
http://m0rkeulv.com/?p=483

_________________
My plugins : http://m0rkeulv.net/plugins/


Wed Aug 31, 2011 10:37 pm
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 12172
Location: London
Reply with quote
This plugin looks awesome :)

PS: typing /** before a function will generate a block comment like you do.


Thu Sep 01, 2011 5:45 pm
Profile WWW
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
yeah i know typing /** will let you generate similar comments but i am more of a shortcut guy :P
so instead of /** i use "ALT+ D" and instead of having to type @ for tags i have added "CTRL+ SPACE".

both shortcuts can be changed using Tools-> keyboard shortcuts.
(AsDocHelper.AddDocumentation, AsDocHelper.AddDocumentationTag)

_________________
My plugins : http://m0rkeulv.net/plugins/


Thu Sep 01, 2011 6:03 pm
Profile
Admin

Joined: Wed Aug 31, 2005 7:27 am
Posts: 12172
Location: London
Reply with quote
BTW there's a typo in your video for the "Resut string" template.


Thu Sep 01, 2011 6:06 pm
Profile WWW
Member

Joined: Mon Feb 23, 2009 12:52 am
Posts: 96
Location: France
Reply with quote
hello

little bug ...

type this :
Code:
   /**
     * @version 1.0
     * @author Lorenzo
     * @link http://web.codeur.free.fr
     */

add a new line just after the URL and you see this :
Code:
   /**
     * @version 1.0
     * @author Lorenzo
     * @link http://web.codeur.free.fr
         *
     */


1 more tabulation is added

the "://" is enough for the problem reproduction :
Code:
    /**
     * ://
     */

add a new line :
Code:
    /**
     * ://
         *
     */



------------
can i have the HTML (<listing version="3.0"></listing>) in the list without adding @example ?


Thu Sep 01, 2011 9:31 pm
Profile WWW
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
The "://" bug actually is only related to ":" and it’s a bug in FlashDevelop so I can’t really fix it without breaking compatibility for future versions. I have found it a bit annoying myself but I usually just make an extra line or 2 before writing an URL.

Another bug that I am unsure if I can fix is the one where tying a "<" or a ">" makes the auto-completion disappear, I think this is also something that will have to be fixed in the FlashDevelop code as I don’t want to start attempting to override stuff that origins from deep within FlashDevelops core :P

_________________
My plugins : http://m0rkeulv.net/plugins/


Thu Sep 01, 2011 10:19 pm
Profile
Member

Joined: Thu Sep 01, 2011 12:51 pm
Posts: 5
Reply with quote
plugin is super! I'll use it in blackberry development. m0rkeulv keep rolling))

_________________
http://coop-site.net/concours/wakka.php ... onebooster About Cell Phone Signal Booster


Mon Sep 19, 2011 12:04 pm
Profile
Member

Joined: Thu Dec 15, 2011 8:33 am
Posts: 3
Reply with quote
Wow. This plugin is amazing! Thank You m0rkeulv!

P.S. Now I waiting for a final version :)


Thu Dec 15, 2011 2:52 pm
Profile
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
Haven’t had much time to finish it lately (been preparing for my exams), but I’ll try to finish it over Christmas.

_________________
My plugins : http://m0rkeulv.net/plugins/


Fri Dec 16, 2011 12:29 am
Profile
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
new version released (v 1.5) see the top of the page for details.

_________________
My plugins : http://m0rkeulv.net/plugins/


Sun Dec 18, 2011 8:09 pm
Profile
Member

Joined: Tue Jul 26, 2011 12:37 am
Posts: 19
Reply with quote
version 1.76 has now been released, feedback wanted. :)

_________________
My plugins : http://m0rkeulv.net/plugins/


Thu Jan 19, 2012 3:02 pm
Profile
Member

Joined: Mon Feb 23, 2009 12:52 am
Posts: 96
Location: France
Reply with quote
hello

just a little problem with checkbox position
Image

Image

FD4.0.0 rtm
xp sp3


Mon Jan 23, 2012 11:30 am
Profile WWW
Display posts from previous:  Sort by  
Reply to topic   [ 21 posts ]  Go to page 1, 2  Next

Who is online

Users browsing this forum: No registered users and 3 guests


You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum

Search for:
Powered by phpBB © 2000, 2002, 2005, 2007 phpBB Group.
Designed by ST Software for PTF.