Skip to content

A plugin for Notepad++, which aids in documentation. It generates documentation templates for functions. Supports C/CPP, Java and PHP

Notifications You must be signed in to change notification settings

kapilratnani/DocIt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

author
Kapil Ratnani
Dec 22, 2012
0a146e1 · Dec 22, 2012

History

18 Commits
Apr 24, 2011
Apr 24, 2011
Dec 22, 2012
May 9, 2011
May 9, 2011
Apr 23, 2011
Dec 4, 2011
Jun 15, 2012
Apr 24, 2011
Jun 15, 2012
Aug 20, 2011
Apr 23, 2011
Dec 4, 2011
May 9, 2011
Apr 23, 2011
Dec 22, 2012
Apr 23, 2011
Apr 23, 2011
Apr 23, 2011
Apr 23, 2011
Nov 1, 2011
Apr 23, 2011
May 9, 2011
Dec 22, 2012

Repository files navigation

=================
DocIt 0.91 Alpha
by Kapil Ratnani
=================

A plugin for Notepad++, which aids in documentation. It generates documentation templates for functions. Currently it supports C/CPP, Java and PHP.

============
Instruction:
============
1. Paste the file "NPPDocIt.dll" and the folder "nppdocitplugins" to Notepad++ plugin folder
2. open a C/CPP/JAVA/PHP file.
3. Go to a function defination and press "CTRL+ALT+SHIFT+D"
4. This will insert a documenation string for the function, in a format depending on the language.

==================
Special Thanks to:
==================
Don Ho for Notepad++
Creators of PCRE

==================
Latest Updates:
==================
---------
0.91 Alpha
---------
-Fixed PHP doc string format

---------
0.9 Alpha
---------
-Separate plugin for each type of language
-Still statically linked pcre
-Support for PHP

---------
0.5 Alpha
---------
-First Release
-Statically linked pcre
-Rough code..not refractored at all
-Just works..
-Support for c/cpp and java

TODO:
-----
-Add support for Javascript,sql script..etc.. -- Added PHP
-Refractor the code -- done to some extent
-Think of a way for expansion -- separate plugin for each language
-Add support for inserting licenses 
-try to fully comply with documentation generators
-add support for more languages -- Added PHP
-Document the code :P -- done to some extent
-Add a wiki entry somewhere with instructions to create plugins
-Work on making more exhaustive api for plugins, so that all types of language can be integrated

About

A plugin for Notepad++, which aids in documentation. It generates documentation templates for functions. Supports C/CPP, Java and PHP

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published