Coder Social home page Coder Social logo

dail8859 / doxyit Goto Github PK

View Code? Open in Web Editor NEW
68.0 12.0 13.0 431 KB

Notepad++ plugin for Doxygen commenting

License: GNU General Public License v2.0

C++ 65.18% C 34.49% C# 0.07% Java 0.06% JavaScript 0.05% PHP 0.08% Python 0.07%
doxygen notepad-plus-plus plugin

doxyit's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

doxyit's Issues

Member Variable / Class Documentation Support

It would be great if DoxyIt supported class and member variable documentation as well.

Ideally this would be implemented as additional radio buttons near the top of the settings dialog:
image

[QtCreator demonstrates this behavior, but is not nearly as customizable as your wonderful plugin].

Parser fails on C++ operator overloads

Trying to comment a C++ method like

constexpr inline bool operator!= (const A & o) const {
	return this->value != o.value;
}

fails with the error message "Error: Cannot parse function definition. Make sure the cursor is on the line directly above the function or method definition.".

Not recognizing language

Hi,

I have my own stylesheet for php (user defined language), however, even if its named php with extension php doxyit gives a popup of "Unrecognized language type.

Can i fix this somehow?

recognized-user-defined-language

$FUNCTION not recognizing function name

In both python and C the function name returned is an empty string. I haven't looked through this code at all really, but (at least for C) shouldn't the regex be something similar to "\s+\w+\s*[(]" ? Then you can strip the open parenthesis and whitespace to get the function name.

Doesn't support UDL with same name as built in parser

A feature bug with the way windows handles INI files doesn't allow sections to be distinguished based on string case, thus a UDL with the name php gets mistaken for the built in type of PHP.

May need to use custom INI handling functions to allow this.

Add new line after first

I add comment for method:

/**
 * @return string
 */
private function getLogPath($name = 'error')
{

and try add line after first line (set cursor after /** and press Enter):

/**
 * New line after first line (not work now).
 * @return string
 */

But plugin add new comment:

/**
 * 
 */ 
 * @return string
 */

Cannot comment a function on javascript

It works fine with the following function declaration:
function Space(a) {
this.models = {};
this.handles = {};
this.reconnectHandle = null;
this.configure(a);
}

but failed with the following:

Space.prototype.connect = function () {
this.lnodeClient.connect(this._options.nodeaddr,
this._options.nodeid)
}

Error info--> Error:Cannot parse function definition.Make sure the cursor is on the line directly above the function or method definition.

No longer work for JS on Notepad++ 6.8.6

Hi,

The last Notepad++ version introduced changes on the language detection, which broke the plugin while working with Javascript files.

Taking a look at the latest Notepad_plus_msgs.h we can see they introduced a new L_JAVASCRIPT type on the LangType enum, so i think it's just a matter of additionally checking for that.

Cheers.

flexible spacing

I am working on an old app in which all existing doxygen comments have a single space after the asterisk:

/**
*_comment
*/

When I need to add a line in these comments, the plugin does not automatically extend the asterisk:

/**
*_comment
newline with no asterisk
*/

It looks like the plugin needs to see two spaces to consider it a doxygen comment.

/**
*__comment
*__newline with asterisk
*/

Any chance you modify your plugin to make it less sensitive to the number of spaces?

Thanks!

Parser fails on C++ functions with conditional template instantiation and parameter packs

Trying to comment a C++ function like

template <size_t i = 0, typename ...Args>
static typename enable_if<i == sizeof...(Args), bool>::type extractArgs(uint8_t * &, size_t &, tuple<Args...> &) {
	return true;
}

fails with the error message "Error: Cannot parse function definition. Make sure the cursor is on the line directly above the function or method definition.".

Enhancement: Conditional DoxyIt Parameters

It would be great if the parser could conditionally determine whether certain Doxygen tags would be beneficial. For instance,

if <return type is not void> {
  $@return $(Return description)
} else {

}

i.e., only add the Doxygen comment for a return if there is a non-void return type.

Thanks for considering!

Get confused when function parameter type include template arguments

/**
 @brief Brief

 @param [in] uint32_t Parameter_Description
 @param [in] val Parameter_Description
 @return Return_Description

 @details Details
*/
uint32_t getQbbTime(std::pair<uint32_t, double> val)
{

    auto microseconds = val.first *1000000LL + static_cast<uint64_t>(val.second * 1e6);
    return static_cast<uint32_t>(microseconds % UINT32_MAX);

}

Indentation tabs

Hi,

first of all, thank you for this great plugin!

One maybe small issue: The "active comments" (typing /** enter to generate a comment) always use tabs as indentation. Would it be possible to honor the tab/spaces settings from NPP?

Sadly some code receivers (projects, companies, whatever) are very strict about their tab/space preferance.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.