Commit 073678e8 authored by Thomas BOUTROUE's avatar Thomas BOUTROUE

Update help meta-data

parent b9ce45fd
......@@ -2,7 +2,7 @@
#include "Help.h"
static ObjectHelp basicObject {
"BasicObject", "object", { }, { "Node", "Board", "AbstractIO", "AbstractSensor", "AbstractActuator", "AbstractRoutine", "AbstractLink", "AbstractTransformer", "PhysicalValue", "PhysicalPoint", "PhysicalSize", "PhysicalAngle", "PhysicalBlock", "PhysicalMarker", "PhysicalWorld", "SerialBus", "CanBus", "CanOpen" }, "abstract class",
"BasicObject", "object", { }, { "Node", "Board", "AbstractIO", "AbstractSensor", "AbstractActuator", "AbstractRoutine", "AbstractLink", "AbstractTransformer", "PhysicalValue", "PhysicalPoint", "PhysicalSize", "PhysicalAngle", "PhysicalBlock", "PhysicalMarker", "PhysicalWorld", "SerialBus", "CanBus", "CanOpen", "ObjectsGroup" }, "abstract class",
{
new PropertyHelp {
"family", "enum (ObjectFamily)", "constant", false,
......@@ -27,6 +27,20 @@ static ObjectHelp basicObject {
"The root class for every identifiable object (has a type enum, an UID...)."
};
static ObjectHelp objectsGroup {
"ObjectsGroup", "object", { }, { "object" }, "instantiable",
{
new PropertyHelp {
"subObjects", "object", "writable", true,
"The list of children objects. This is the default property."
}
},
{ },
{ },
{ },
"A generic component to group relative objects together, giving them a common 'folder' in their UID path. It allows creating macro-components (e.g: physical blocks + sensors + actuators)."
};
static ObjectHelp abstractSensor {
"AbstractSensor", "BasicObject", { "AnalogSensor", "DigitalSensor" }, { }, "abstract class",
{
......@@ -1185,7 +1199,7 @@ static ObjectHelp physicalMarker {
};
static ObjectHelp physicalWorld {
"PhysicalWorld", "BasicObject", { }, { "PhysicalBlock", "PhysicalMarker", "PhysicalValue" }, "instantiable",
"PhysicalWorld", "BasicObject", { }, { }, "grouped-property",
{
new PropertyHelp {
"bounds", "PhysicalSize", "grouped property", false,
......@@ -1195,7 +1209,7 @@ static ObjectHelp physicalWorld {
{ },
{ },
{ },
"The container object for all physical objects, giving them a referential and boundary."
"The referential and boundary of physical world. It's used as the 'world' property of the NetworkDefinition."
};
static ObjectHelp board {
......@@ -1281,7 +1295,7 @@ static ObjectHelp networkDefinition {
"Enabled this to have debug message with elapsed time after each all routines for a CAN frame ID have been executed (to know the time spent parsing frame and optionally answering it)."
},
new PropertyHelp {
"world", "PhysicalWorld", "writable", false,
"world", "PhysicalWorld", "grouped-property", false,
"The physical world and its blocks and values this network."
},
},
......@@ -2876,6 +2890,7 @@ ObjectHelp * Help::getHelpForTypeByName (const QString & name) {
void Help::initMap (void) {
registerHelp (basicObject);
registerHelp (objectsGroup);
registerHelp (objectRefListModel);
registerHelp (abstractSensor);
registerHelp (analogSensor);
......@@ -2970,6 +2985,7 @@ void Help::initIndex (void) {
{
new HelpPage { 1, "NetworkDefinition" },
new HelpPage { 1, "BasicObject" },
new HelpPage { 1, "ObjectsGroup" },
new HelpPage { 1, "ObjectRefListModel" },
}
},
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment