I was able to add custom pages to the doxygen documentation even with a description (which is not realy documentated). However I have this here:
/*!
* \page fielname Here comes the title
* \brief A short introduction which explains this page.
*
* The real page content...
*/
That works fine but how I add a \brief (description) for the deprecated list? Now that looks a undocumentated page what I want to avoid.
I think what you are looking for can be achieved with the following:
/** Test class
* #deprecated Will be removed in release 2.0
*/
class Test
{
};
/** #page deprecated
* #brief Deprecated page brief
*
* Deprecated page contents.
*/
Related
I'm starting to learn Prestashop, so I've downloaded a free theme and started to edit it. But I have a problem with the navbar and now I need to edit it.
This is my navbar:
I need to add all my categories to the category section of the navbar, but I'm not able to do it. This theme uses Leo Bootstrap Mega Menu. So when I edited that module to add a product, it gives me the following error:
How would I fix this?
Your theme or module uses a function that is not included in your version of Prestashop. Try to put this function in your classes/Language.php file before the last }.
/**
* Returns an array of language IDs.
*
* #param bool $active Select only active languages
* #param int|bool $id_shop Shop ID
*
* #return array
*/
public static function getIDs($active = true, $id_shop = false)
{
return self::getLanguages($active, $id_shop, true);
}
As for #Roman K suggestion. I recommend you should add the code to overrides folder. It will be easier for you when you upgrade to new version of Prestashop.
If you still get the error. I think you should download other Prestashop Mega Menu Module.
/**
* Comment.
*
* <p>Hello
*
* #author me (me#domain.com)
* #version $Id$
* #since 0.1
* #checkstyle ClassDataAbstractionCoupling (500 lines)
* #checkstyle ClassFanOutComplexity (500 lines)
*/
When I reformat my code with Ctrl+Alt+L, the #since is placed after the #checkstyle tags. Is there any way to disable javadoc tag rearrangement on code reformatting?
You can uncheck Enable JavaDoc formatting in Settings/Code Style/Java/JavaDoc, which should fix the problem.
However this means that no other formatting will be performed (wrapping, alignining, etc). I haven't found a way to disable just the rearranging of tags.
You can also use this plugin with disabled JavaDoc formatting in IDEA.
With that combination you still have an asterisk * inserted at newline, and you can configure all generated JavaDoc templates for each part of code.
It also has a feature of upgrade existing JavaDoc.
I'm trying to add a link to a UIKit method in my own documentation.
According to this documentation, I should add a #see tag with an //apple_ref/ link.
Here's my documentation :
/**
* Creates and add constraints to the receiver
*
* #return The constraints that were added.
*
* #see //apple_ref/occ/clm/NSLayoutConstraint/constraintsWithVisualFormat:options:metrics:views:
*/
And here's the result:
Any idea how should I do it ?
EDIT: Same question goes for #see in the same file.
In an effort to adapt a company-wide header format to doxygen, I would like to create some custom tags that will be ignored by doxygen. I think I can do this with an alias, but so far have only been able to replace tags with others. What I am trying to accomplish:
/**
* #company Company Name
**/
with an alias like #company="". Unfortunately, this just prints the text with no section name.
Any ideas?
You could use HTML style comments to hide parts, i.e.
/** Show this <!-- but hide this --> and show this again */
Or you could use #if...#endif
/** Show this #if VISIBILE but hide this #endif and show this again */
To save typing you could define a pair of aliases
ALIASES = hide="#if VISIBLE" endhide="#endif"
and then write
/** Show this #hide but hide this #endhide and show this again */
When I create a Java file a Javadoc command author is added to file by me. Intellij IDEA also adds date and time which are not yet implemented to Javadoc yet as a comment. When I do auto code indentation it becomes like that:
/**
* #author kamaci
* Date: 11.01.2013
* Time: 00:47
*/
instead of:
/**
* #author kamaci
* Date: 11.01.2013
* Time: 00:47
*/
How to achieve it?
You probably want to uncheck "align parameter descriptions" in Settings->Code Style->Java->JavaDoc(tab)
You can uncheck "Enable leading asterisks".
Reference: https://www.jetbrains.com/help/idea/2016.1/code-style-java.html?origin=old_help