Updated documentation and made it work with Doxygen. Now the doc/doxygen/index.html generated with it looks quite good and contains lots of useful and up-to-date information about Astaroth
This commit is contained in:
@@ -41,16 +41,48 @@ typedef struct {
|
||||
Grid subgrid;
|
||||
} DeviceConfiguration;
|
||||
|
||||
/** */
|
||||
/**
|
||||
Initializes all devices on the current node.
|
||||
|
||||
Devices on the node are configured based on the contents of AcMesh.
|
||||
|
||||
@return Exit status. Places the newly created handle in the output parameter.
|
||||
@see AcMeshInfo
|
||||
|
||||
|
||||
Usage example:
|
||||
@code
|
||||
AcMeshInfo info;
|
||||
acLoadConfig(AC_DEFAULT_CONFIG, &info);
|
||||
|
||||
Node node;
|
||||
acNodeCreate(0, info, &node);
|
||||
acNodeDestroy(node);
|
||||
@endcode
|
||||
*/
|
||||
AcResult acNodeCreate(const int id, const AcMeshInfo node_config, Node* node);
|
||||
|
||||
/** */
|
||||
/**
|
||||
Resets all devices on the current node.
|
||||
|
||||
@see acNodeCreate()
|
||||
*/
|
||||
AcResult acNodeDestroy(Node node);
|
||||
|
||||
/** */
|
||||
/**
|
||||
Prints information about the devices available on the current node.
|
||||
|
||||
Requires that Node has been initialized with
|
||||
@See acNodeCreate().
|
||||
*/
|
||||
AcResult acNodePrintInfo(const Node node);
|
||||
|
||||
/** */
|
||||
/**
|
||||
|
||||
|
||||
|
||||
@see DeviceConfiguration
|
||||
*/
|
||||
AcResult acNodeQueryDeviceConfiguration(const Node node, DeviceConfiguration* config);
|
||||
|
||||
/** */
|
||||
|
Reference in New Issue
Block a user