I'm using WebStorm and it has a concept of a "Symbol". For example, I can view Symbol usages. It locates all methods of classes.
So what is Symbol? A class method?
I'd say that 'Symbol' there mostly means 'Identifier' - it can be a class/function/variable, CSS selector, HTML tag, etc.
Related
I'm trying to have doxygen show a brief summary of the function in `Files->File Members->Functions'
For Example:
I want this:
Box_The_Function_Name() : doxygen_c.h
to look like this
Box_The_Function_Name() : doxygen_c.h : brief explanation
Doxygen does this automatically for structs but not functions.
Any ideas ?
Doxygen does this automatically for structs but not functions.
No, it doesn't. Classes/types are not represented on this page at all, but instead in the list of classes, which is a completely different page with a different paradigm.
On this page, where functions, variables and defines are listed, the nature of translation units means that the same name could be found in multiple files, e.g.:
Box_The_Function_Name() : A.h , B.h, C.h
Here's a real-world example from my commercial project (don't tell anyone):
parse_options() : debug-register-reader.cpp , main.cpp , metrics-converter.cpp , debug-register-writer.cpp
The function parse_options() in each file is different, and may have a different summary text. It would not be very user-friendly if Doxygen tried to cram each summary text into a list here.
So, no, you can't do this.
However, you can simply click on the filename to go to the documentation for the function as found in that file.
In Doxygen you use reference links: define them separately and then refer to them from within the text.
/**
* This is a documentation. Here I link [std::string] to an external web page.
*
* The next line is the link definition:
*
* [std::string]: http://en.cppreference.com/w/cpp/string/basic_string "std::string documentation"
*/
However it seems that the link definition is seen only within the documentation block. It is not seen even on other documentation blocks on the same page.
I want to define some links once, and then use them everywhere (on different pages).
Is that possible?
Edit (follow-up question)
In order to achieve your aim I think your best bet is to make use of the ALIAS facility.
I have managed to set it up with alias like this:
ALIASES += std_string="std::string "
ALIASES += std_vector="std::vector "
And using it:
#std_string
#std_vector
Basically I have one alias for each link.
Can it be achieved with one alias with parameters? The use would be:
#std_ref std::string
#std_ref std::vector
The problem is that some sort of map is needed between the name (the parameter) and the link:
std::string -> http://en.cppreference.com/w/cpp/string/basic_string
std::vector -> http://en.cppreference.com/w/cpp/container/vector
I know it can be done if one parameter would be the different part of the link, like :
#std_ref std::string string/basic_string
#std_ref std::vector container/vector
But this is ugly, error prone and would require to check each time what the link should be.
It's worth noting that what you are currently using is the notation that comes only with Doxygen's support for Markdown - it's not the doxygen method for external links. The original Doxygen method is to insert an HTML link inline...
link text
... but that makes no difference to your original problem.
In order to achieve your aim I think your best bet is to make use of the ALIAS facility. The relevant manual page is here. Using them, you should be able to define an alias like std-string and have it insert the HTML link everywhere you use the alias.
ALIASES are set up in the doxyfile config file (in this section of the manual)
You could set up aliases manually for every C++ keyword, that you want to link to, but the better way to do this is to use the doxygen TAGFILES feature.
A tag file is basically a compact representation of the entities found in the external sources. Doxygen can both generate and read tag files.
To generate a tag file for your project, simply put the name of the tag file after the GENERATE_TAGFILE option in the configuration file.
To combine the output of one or more external projects with your own project you should specify the name of the tag files after the TAGFILES option in the configuration file.
Doxygen has a whole page dedicated to explaining how to link to external documentation
And cppreference.com has already setup a tag file for you with some basic instructions.
For the impatient:
Download File:cppreference-doxygen-web.tag.xml for linking directly to cppreference.com website.
Add this line to your Doxyfile:
TAGFILES += "location/of/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/"
How can I add additional templates to mod_banners in j2.5? From the module configuration you can choose the template - which is just default.php by default.
I've tried adding my modified template to the tmpl folder but it doesnt appear in the drop down in the module parameters - can anyone shed any light? I want to use multiple templates so I have already modified tmpl/default.php
Your filename should be mytemplate.php. Joomla uses underscores to process templates and sub template files. The dropdown checks for files without an underscore and only shows those.
That form field uses the field type modulelayout. This core layout uses a regex to avoid names with underscores in them: ^[^_]*\.php$.
No underscore and you will be good to go.
I have installed ModX and Downloaded the "Basic" Template in the Extensionmanager! I chose the Basic Template at my first Page for the Resource! I cant find a Globalsetting to choose an Template? My problem is that if iam going to the site i only get the pure html code shown, no website! Why is this?
AFAIK there is no "Globalsetting" to choose a template. One of the nice things with MODX is that each resource can specify which template to use. So you can mix and match as required.
You could check if you have set the base href tag in head like this:
<base href="http://www.yoursite.com"/>
It will tell the site where to start looking for the other files that you have included in your markup.
I'm looking for a fast way to display a particular template file based on the current language of the page.
Let's say I have two languages : english and french (english being the default)
I have various templates files, like : page.tpl.php page-node-11.tpl.php in my theme directory.
I'd like to find out a way to include these files based on the current languages; so for example if the current language is 'english', it will include 'page.tpl.php', if the current language is 'french' it will include 'fr/page.tpl.php'.
I'm sure it's pretty straight forward, but can't figure out how; in template.php ?
Thanks for any help.
Assuming you're using the Internationalization module, rather than changing the template per language, you may want to consider taking advantage of the CSS class set on the body tag. I've used that technique on sites before and it was easier than dealing with another template file. If you don't use the i18n module, you could still add the body class inside a preprocess_page function.
If a body class won't work for you, you could look at the patch from the issue above for an example of how to add the language to the variables array during preprocessing. Then see the Working with template suggestions handbook page for how to add template suggestions based on the newly added language info.