Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Attributes
gmx_ana_selmethod_help_t Struct Reference

#include <gromacs/selection/selmethod.h>

Description

Help information for a selection method.

If some information is not available, the corresponding field can be set to 0/NULL.

Public Attributes

const char * syntax
 One-line description of the syntax of the method. More...
 
const char * helpTitle
 Title for the help text in help. More...
 
int nlhelp
 Number of strings in help. More...
 
const char *const * help
 Detailed help for the method. More...
 

Member Data Documentation

const char* const* gmx_ana_selmethod_help_t::help

Detailed help for the method.

If there is no help available in addition to syntax, this can be set to NULL.

const char* gmx_ana_selmethod_help_t::helpTitle

Title for the help text in help.

If NULL, the name of the method is used. Only used if nlhelp > 0.

int gmx_ana_selmethod_help_t::nlhelp

Number of strings in help.

Set to 0 if help is NULL.

const char* gmx_ana_selmethod_help_t::syntax

One-line description of the syntax of the method.

If NULL, the name of the method is used.


The documentation for this struct was generated from the following file: