Snippets - Intelli sense and errors

::: doxy tag

This tag shows all possible tags and their parameters.

Tag usageTag result

::: doxy

MkDoxy Error: Incorrect project name:

Project name have to contain [a-zA-Z0-9_]

A list of available projects:

mkdoxyApi
animal

Snippet

::: doxy
indent_level: 4

Error handling

When you configured the snippet incorrectly, MkDoxy show you an error message with a hint how to fix it.

Tag usageTag result

::: doxy.animal

MkDoxy Error: Add argument to snippet: animal

Argument have to be based on this diagram → :::doxy.animal.<argument>

A list of available arguments:

code
function
class
class.method
class.list
class.index
class.hierarchy
namespace.list
file.list

Snippet

::: doxy.animal
indent_level: 4

Incorrect arguments

When you configured the snippet with incorrect arguments, mkdoxyApi will show you an error message.

Tag usageTag result

::: doxy.animal.class.method
name: cat

MkDoxy Error: Incorrect class configuration

Did not find Class with name: example::Cat

Available classes:

CuteChinchilla
example::Animal
example::Bird
example::CustomException
example::NumericException
example::SpecialBird
example::inner\_namespace::Vector

Snippet

::: doxy.animal.class
name: example::Cat
indent_level: 4

Hints for parameters

Tag usageTag result

::: doxy.animal.class.method
name: mkdoxy::cache::Cache

MkDoxy Error: Missing parameter: method

This parameter is required

Required parameters:

name
method

Snippet

::: doxy.animal.class.method
name: mkdoxy::cache::Cache
indent_level: 4