Projects/KDevelop4/File template specification - Revision history

Milianw at 00:48, 28 November 2012

2012-11-28T00:48:36Z

Milianw at 00:39, 28 November 2012

2012-11-28T00:39:37Z

Miha: /* Entries */ Document the BaseClasses entry

2012-08-15T12:46:14Z

‎Entries: Document the BaseClasses entry

Miha: /* Tests */ Typo fix

2012-08-10T08:56:45Z

‎Tests: Typo fix

Miha: /* Tests */

2012-08-10T08:51:12Z

‎Tests

Miha: /* C++ Specific variables */

2012-08-10T08:47:18Z

‎C++ Specific variables

Miha: /* Generic */

2012-08-10T08:46:09Z

‎Generic

Miha: /* C++ Specific variables */

2012-08-10T08:45:18Z

‎C++ Specific variables

Miha: /* Classes */

2012-08-10T08:35:35Z

‎Classes

Miha: /* Variables */

2012-08-10T08:34:40Z

‎Variables

@@ Line 29: / Line 29: @@
 Name=Private Pointer
 Comment=C++ Class with a private D-pointer
-Category=Class/C++/Basic
+Category=C++/Basic
 Files=Header,PrivateHeader,Implementation
 OptionsFile=options.kcfg
@@ Line 53: / Line 55: @@
 The <tt>Name</tt> and <tt>Comment</tt> entries are the same as in other <tt>.desktop</tt> files and can be translated.
-The <tt>Type</tt> is mandatory and must be either <tt>Class</tt>, <tt>Test</tt> or <tt>Other</tt>. The first two receive some additional configuration and variables.
+The <tt>Category</tt> is used for grouping when showing a list of templates to the user. It should contain at least two levels, separated by slashes. The default templates use the following format: <tt>Language/Framework</tt>, e.g. <tt>C++/Qt</tt>.
-The <tt>Language</tt> is optional and can reference a KDevelop language plugin by it's <tt>X-KDevelop-Language</tt> identifier. When given, the language plugin will be asked to create a class helper, otherwise a default class helper will be chosen.
+The <tt>Type</tt> is optional and can be either <tt>Class</tt> or <tt>Test</tt>. In both cases the wizard will add some additional configuration pages and variables.
-The <tt>Category</tt> is used for grouping when showing a list of templates to the user. It should contain at least two levels, separated by slashes. The default templates use the following format: <tt>Language/Framework</tt>, e.g. <tt>C++/Qt</tt>.
+The <tt>Language</tt> is optional and can reference a KDevelop language plugin by it's <tt>X-KDevelop-Language</tt> identifier. When given, the language plugin will be asked to create a class helper, otherwise a default class helper will be chosen.
 The <tt>OptionsFile</tt> entry is optional, using it specifies configuration options for this template. For more information about template options, see [[Projects/KDevelop4/Class_template_specification#Custom_options|Custom options]].

@@ Line 51: / Line 51: @@
 ==== Entries ====
-The <tt>Name</tt> and <tt>Comment</tt> entries are the same as in other <tt>.desktop</tt> files and can be translated. The <tt>Category</tt> is used for grouping when showing a list of templates to the user. It can contain more than one level, separated by slashes. The first level must be the template type, either <tt>Class</tt> or <tt>Test</tt>. Templates with other type can be used, but classes and tests receive some additional configuration and variables. It is recommended that the second level is the language name, and the third the framework name.
+The <tt>Name</tt> and <tt>Comment</tt> entries are the same as in other <tt>.desktop</tt> files and can be translated.
 The <tt>OptionsFile</tt> entry is optional, using it specifies configuration options for this template. For more information about template options, see [[Projects/KDevelop4/Class_template_specification#Custom_options|Custom options]].

← Older revision		Revision as of 12:46, 15 August 2012
Line 54:		Line 54:

	The <tt>OptionsFile</tt> entry is optional, using it specifies configuration options for this template. For more information about template options, see [[Projects/KDevelop4/Class_template_specification#Custom_options\|Custom options]].		The <tt>OptionsFile</tt> entry is optional, using it specifies configuration options for this template. For more information about template options, see [[Projects/KDevelop4/Class_template_specification#Custom_options\|Custom options]].
		+
		+	A class template description file may also contain an entry with key <tt>BaseClasses</tt>. It is only used for class templates, and any clases specified in this way are added by default to the inheritance list for the new class. The user can still remove those base classes, or add them manually, so this entry is entirely optional, it only makes things easier for the user. It accepts a list of inheritance statements, separated by commas, like so
		+
		+	<syntaxhighlight lang="ini">
		+	; Example for a Qt object
		+	BaseClasses=public QObject
		+	; Example for a KDevelop plugin that implements an interface
		+	BaseClasses=public KDevelop::IPlugin,public KDevelop::IBasicVersionControl
		+	; Example for a Python new-style class
		+	BaseClasses=object
		+	</syntaxhighlight>

	==== Output files ====		==== Output files ====

@@ Line 181: / Line 181: @@
 ==== Tests ====
-The following variables are passed to <tt>Test/tt> templates
+The following variables are passed to <tt>Test</tt> templates
 {| class="wikitable"

← Older revision		Revision as of 08:51, 10 August 2012
Line 181:		Line 181:

	==== Tests ====		==== Tests ====
		+	The following variables are passed to <tt>Test/tt> templates
		+
		+	{\| class="wikitable"
		+	!Variable name
		+	!Type
		+	!Description
		+	!Example value
		+	\|-
		+	\|name
		+	\|String
		+	\|Test name without namespaces
		+	\|MathTest
		+	\|-
		+	\|testCases
		+	\|StringList
		+	\|List of test case names. They do not necessarily begin or end with "test", it is up to templates for frameworks that require such prefixes to add them.
		+	\|[addition, multiplication, negativeNumbers]
		+	\|-
		+	\|}

	=== Additional templates and filters ===		=== Additional templates and filters ===

@@ Line 145: / Line 145: @@
 The variables which are passed to class templates are also described in the {{class|TemplateClassGenerator|kdevelop|extragear}} API documentation.
-===== C++ Specific variables =====
+==== C++ Specific variables ====
 Templates for classes in C++ may make use of some additional variables provided by the language support plugin. They cover finding include files and grouping class functions and members by access specifiers.

@@ Line 95: / Line 95: @@
 |}
-Additionally, values of any [http://techbase.kde.org/Projects/KDevelop4/File_template_specification#template_options template options] exposed by the template are passed as variables.
+Additionally, values of any [http://techbase.kde.org/Projects/KDevelop4/File_template_specification#Custom_options custom options] exposed by the template are passed as variables.
 ==== Classes ====

← Older revision		Revision as of 08:45, 10 August 2012
Line 146:		Line 146:

	===== C++ Specific variables =====		===== C++ Specific variables =====
		+
		+	Templates for classes in C++ may make use of some additional variables provided by the language support plugin. They cover finding include files and grouping class functions and members by access specifiers.
		+
		+	{\| class="wikitable"
		+	!Variable name
		+	!Type
		+	!Description
		+	\|-
		+	\|public_functions, protected_functions, private_functions
		+	\|FunctionDescriptionList
		+	\|Class functions grouped by access modifiers. These lists do not include slots.
		+	\|-
		+	\|public_slots, protected_slots, private_slots
		+	\|FunctionDescriptionList
		+	\|Qt slots grouped by access modifiers
		+	\|-
		+	\|signals
		+	\|FunctionDescriptionList
		+	\|All Qt signals in the new class
		+	\|-
		+	\|public_members, protected_members, private_members
		+	\|VariableDescriptionList
		+	\|Data members grouped by access modifiers
		+	\|-
		+	\|needs_qobject_macro
		+	\|bool
		+	\|<tt>true</tt> if the class has at least one signal or slot, <tt>false</tt> otherwise
		+	\|-
		+	\|included_files
		+	\|StringList
		+	\|List of headers files that need to be included. This variable lists the missing include files for base classes.
		+	\|-
		+	\|}

	==== Tests ====		==== Tests ====

← Older revision		Revision as of 08:35, 10 August 2012
Line 144:		Line 144:

	The variables which are passed to class templates are also described in the {{class\|TemplateClassGenerator\|kdevelop\|extragear}} API documentation.		The variables which are passed to class templates are also described in the {{class\|TemplateClassGenerator\|kdevelop\|extragear}} API documentation.
		+
		+	===== C++ Specific variables =====

	==== Tests ====		==== Tests ====

@@ Line 69: / Line 69: @@
 === Variables ===
 The following variables are passed to all templates, regardless of their type
@@ Line 96: / Line 97: @@
 Additionally, values of any [http://techbase.kde.org/Projects/KDevelop4/File_template_specification#template_options template options] exposed by the template are passed as variables.
 The following variables are passed to <tt>Class</tt> templates
@@ Line 142: / Line 144: @@
 The variables which are passed to class templates are also described in the {{class|TemplateClassGenerator|kdevelop|extragear}} API documentation.
 === Additional templates and filters ===