dail8859 / doxyit Goto Github PK
View Code? Open in Web Editor NEWNotepad++ plugin for Doxygen commenting
License: GNU General Public License v2.0
Notepad++ plugin for Doxygen commenting
License: GNU General Public License v2.0
very useful
Whenever I type /** and press [Enter], nothing happens. DoxyIt File/Function work fine. Using NP++ 7.7.1 (64-bit).
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.".
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.
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.
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
*/
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.
Comment does not extend automatically for pasted block of text.
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.
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!
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.".
should be the reason:
I don't have MSVC2017 in my computer.
Can you help to recompile and release it?
Thank you.
Reports "Unknown exception" when function is following format:
void fun
(
int param
)
{
}
But when parenthesis and function in the same line, everything is OK.
void fun (
int param
)
{
}
Our strange coding standard. Please!
Thanks in advance.
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!
/**
@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);
}
function get_user_name($uid='',$type='username',$key='sub'){
I suggest to create a comment in any case, even on error, and output parsing error messages as text there instead of in an additional message box. This will ensure that parsing errors do not hinder one from writing comments.
@dail8859 not full fixed
/**
* Work fine!
* Whitespace after *
*/
See:
/**
* Bug :(
*/
*No whitespace after *
*/
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.
It would be nice if you add support for the "$TYPE" format keyword.
For "C", "C++", "Java" and "C#", types are part of the language and can be extracted following rules of each language.
For "Python" and "PHP" types should be extracted following respective types hints:
For "JavaScript" : /* no comment */
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.