I think my question is basically the same as this one, but it didn't get a good answer: Create new custom command that will add to a section in Doxygen
I pretty much want to do the same thing, I think. I want to completely duplicate the exact functionality of the #param option, except to give it the heading "Options" instead of "Parameters". I want the arguments to be the same (data type, variable name, and description) and want them to look all the same and everything. Literally, the only thing I need different is the heading.
I also tried doing this:
ALIASES = option"\par Options:\n"
in my Doxyfile, but I also get each individual option in its own section instead of all of them being in the same section. They also don't have the same arguments as the #param option.
I also tried to do something with \xrefitem which, of course, didn't work. I tried this:
ALIASES = option="\xrefitem param \"Option\" \"Options\" "
but it looks like \xrefitem is used for creating something more like a compiled list from different sections, like the Todo list.
Help is greatly appreciated. Thanks!
EDIT:
Just to clarify, the output I'm looking for would look something like this:
Options:
string $option1 This is option 1.
string $option2 This is option 2.
The closest I was able to come up with was to use this:
#par Options:
#li #e string #b $option1 This is option 1.
#li #e string #b $option2 This is option 2.
This almost works decently, except that it doesn't line up each part nicely, like it does with #param. So if the first option's name is something like $option1 and the second option's name is $thisIsTheSecondOption, the beginning of the descriptions will not be lined up. It looks more like:
Options:
string $option1 This is option 1.
int $thisIsTheSecondOption This is option 2.
Which makes it more difficult to read.
:-\
I am pretty sure that this is not possible without modifying doxygen. I would just use \li and list the options insteand of using \param then.
http://www.doxygen.nl/manual/commands.html#cmdli
Related
Is there some way to append something to a search result in JetBrains IDEs or VSCode?
Usually I'd use find and replace and just copy the old result and append things but now I am using regex search over multiple files and I need to add a line to all the results.
Usually using find and replace you'll get something like this:
So instead of replacing the search result I want my input to be added the search result.
This should be useful when using RegEx to edit multiple lines that have things in common.
In my case I was looking to add a field to all my enums that are like:
public enum EnumName {
// field1
// field2...
}
To be like :
public enum EnumName {
// default field
// field1
// field2...
}
Thanks to #LazyOne replies, I've been able to find a way to do what I am looking for by using RegEx Capturing Groups that works in JetBrains IDEs (Intellij help) and VSCode too.
It consists on putting the regular expression we want to add something to in parenthesis in the search field and then in the replace field using $1 $2.. to reference the RegExs given the actual order in the search.
In my case using Jetbrains Rider I was looking to add something to all the enums in my solution, and I simply put my RegEx inside () so it became (.* enum .* .*\{) and then used $1 to reference it like this:
I am trying to understand the perl commands below:
$my = << EOU;
This is an example.
Example too.
EOU
What is the name of this way? Could somebody can explain more about this "multi-line writing" command?
Essentially the syntax is allowing you to put anything unique as a marker so that it won't conflict with your contents. You can do this:
$my = <<ABCDEFG;
This is an example.
Example too.
BLAH
ABCDEFG
Everything between "This.." and "BLAH" will be assigned to the variable. Note that you shouldn't have a space after the << symbols otherwise you will get a syntax error. It helps avoid adding CR characters, or append (.) everywhere, and useful when passing data into another application (eg. ftp session). Here Documents is the correct term for this.
Everything between <<EOU and EOU is a multi-line, non-escapable, string. It's nothing fancy, think of them as start and end quote marks with nothing inside requiring escapes to be literally what you typed...
I'm making a custom .tmLanguage file to highlight the syntax I'm using correctly and generally make coding with it easier. I'm almost done, and I got the autocompletion working using a .sublime-completions file.
There's just one minor flaw I'd like to change. I have a pretty long list of functions, and almost all of them contain an abbreviation of the word 'parameter', PAR. When I start typing that word, the following are all in the list of completions:
PAR command
DEFPAR command
JDATA command (because the description contains PAR)
SPAA command (because there's a P in the command and an A and an R in the description)
What I want is only for the commands that begin with PAR to show up, so from the list above, only the first item.
So, like this:
In other words, I want the completions to show up based on the literal string I'm typing, and only from the trigger part of my completions file, before the \t only.
That completions file looks like this:
Highlighted in orange is what I want my completions list to be based on.
I hope this is understandable. Any help is greatly appreciated.
This is not possible. By design Sublime's autocomplete feature uses fuzzy matching, so if there are a number of options that all contain the same pattern, but you don't quite remember which one you want, you can type the pattern and have all of the options available. The more you type, the smaller the list of possible options becomes. This is a good thing®, otherwise you'd have to remember the exact command you're looking for, which kind of defeats the purpose of autocomplete and code hinting.
I am trying to convert my documents into vector-space format using doc2mat
On the website, it says I can use my specified text file where words are white-space separated or on multiple lines. So, I use some code similar to this one:
./doc2mat -mystoplist=stopword.txt -skipnumeric mydocuments.txt myvectorspace.txt
However, when I check the output .clabel file, it still has stop words that's in stopword.txt.
I really do not know how to do this. Someone help me out please? Thank you!
There's one important thing I should remember: I should include ALL the unwanted words in my stop list. This is somewhat difficult since there's always some variations available...
For example, if I want to exclude method I add it to my list. However, the resulting vocabulary may also contain method since there are words like methodist, methods, etc. Then doc2mat by default stems these words and I will still get method in the output.
Another thing is to make sure that "-nostop" option must be provided for user-specified stop list.
HI,
I have the following problem:
Provided a list of values, and using a formatting function passed as argument, display all its elements in a helper buffer. The user would then select one of them using the arrow keys. The returned value must be the chosen entry.
If you have ever used reftex to insert citations, or browse-kill-ring, you know what I'm talking about. Those two examples use custom code to achieve the desired results, but perhaps there is a library that could do that.
(with-output-to-temp-buffer "*Name of buffer*"
(display-completion-list '("foo" "bar" "baz" "qux")))