mdhelp: shuffle order of satellite frontends mdhelp: update various c…

…aptions and add some property descriptions
tvheadend · May 4, 2016 · 3c4907b · 3c4907b
1 parent f9ec734
commit 3c4907b
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 22 deletions.
diff --git a/docs/class/linuxdvb_frontend_dvbs.md b/docs/class/linuxdvb_frontend_dvbs.md
@@ -7,8 +7,8 @@ parameters.
 
 * Other Frontends
   - [Master](class/linuxdvb_frontend_dvbs)
-  - [Slave](class/linuxdvb_frontend_dvbs_slave)
   - [Master (ISDB-S)](class/linuxdvb_frontend_isdb_s)
+  - [Slave](class/linuxdvb_frontend_dvbs_slave)
 * Back to [TV Adapters](tv_adapters) 
 
 ---

diff --git a/docs/markdown/tv_adapters.md b/docs/markdown/tv_adapters.md
@@ -46,8 +46,8 @@ list.
 
 * Frontend
   - [Master](class/linuxdvb_frontend_dvbs)
-  - [Slave](class/linuxdvb_frontend_dvbs_slave)
   - [Master (ISDB-S)](class/linuxdvb_frontend_isdb_s)
+  - [Slave](class/linuxdvb_frontend_dvbs_slave)
 * Satellite Configuration
   - [Universal LNB](class/linuxdvb_satconf_lnbonly)
   - [2 Port](class/linuxdvb_satconf_2port)

diff --git a/src/input/mpegts/linuxdvb/linuxdvb_frontend.c b/src/input/mpegts/linuxdvb/linuxdvb_frontend.c
@@ -182,7 +182,7 @@ const idclass_t linuxdvb_frontend_dvbt_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_dvbt",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbt_class,
-  .ic_caption    = N_("Linux DVB-T frontend"),
+  .ic_caption    = N_("TV Adapters - Linux DVB-T Frontend"),
   .ic_properties = (const property_t[]){
     {
       .type     = PT_BOOL,
@@ -266,7 +266,7 @@ const idclass_t linuxdvb_frontend_dvbs_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_dvbs",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbs_class,
-  .ic_caption    = N_("Linux DVB-S frontend"),
+  .ic_caption    = N_("TV Adapters - Linux DVB-S Frontend"),
   .ic_get_childs = linuxdvb_frontend_dvbs_class_get_childs,
   .ic_properties = (const property_t[]){
     {
@@ -309,7 +309,7 @@ const idclass_t linuxdvb_frontend_dvbs_slave_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_dvbs_slave",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbs_class,
-  .ic_caption    = N_("Linux DVB-S slave frontend"),
+  .ic_caption    = N_("TV Adapters - Linux DVB-S Slave Frontend"),
   .ic_properties = (const property_t[]){
     {
       .type     = PT_STR,
@@ -340,7 +340,7 @@ const idclass_t linuxdvb_frontend_dvbc_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_dvbc",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbc_class,
-  .ic_caption    = N_("Linux DVB-C frontend"),
+  .ic_caption    = N_("TV Adapters - Linux DVB-C Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -351,7 +351,7 @@ const idclass_t linuxdvb_frontend_atsc_t_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_atsc_t",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbt_class,
-  .ic_caption    = N_("Linux ATSC-T frontend"),
+  .ic_caption    = N_("TV Adapters - Linux ATSC-T Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -362,7 +362,7 @@ const idclass_t linuxdvb_frontend_atsc_c_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_atsc_c",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbc_class,
-  .ic_caption    = N_("Linux ATSC-C frontend"),
+  .ic_caption    = N_("TV Adapters - Linux ATSC-C Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -373,7 +373,7 @@ const idclass_t linuxdvb_frontend_isdb_t_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_isdb_t",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbt_class,
-  .ic_caption    = N_("Linux ISDB-T frontend"),
+  .ic_caption    = N_("TV Adapters - Linux ISDB-T Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -384,7 +384,7 @@ const idclass_t linuxdvb_frontend_isdb_c_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_isdb_c",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbc_class,
-  .ic_caption    = N_("Linux ISDB-C frontend"),
+  .ic_caption    = N_("TV Adapters - Linux ISDB-C Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -395,7 +395,7 @@ const idclass_t linuxdvb_frontend_isdb_s_class =
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_isdb_s",
   .ic_doc        = tvh_doc_linuxdvb_frontend_dvbs_class,
-  .ic_caption    = N_("Linux ISDB-S frontend"),
+  .ic_caption    = N_("TV Adapters - Linux ISDB-S Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }
@@ -405,7 +405,7 @@ const idclass_t linuxdvb_frontend_dab_class =
 {
   .ic_super      = &linuxdvb_frontend_class,
   .ic_class      = "linuxdvb_frontend_dab",
-  .ic_caption    = N_("Linux DAB frontend"),
+  .ic_caption    = N_("TV Adapters - Linux DAB Frontend"),
   .ic_properties = (const property_t[]){
     {}
   }

diff --git a/src/input/mpegts/linuxdvb/linuxdvb_rotor.c b/src/input/mpegts/linuxdvb/linuxdvb_rotor.c
@@ -92,20 +92,22 @@ const idclass_t linuxdvb_rotor_class = {
   .ic_super       = &linuxdvb_diseqc_class,
   .ic_class       = "linuxdvb_rotor",
   .ic_doc         = tvh_doc_linuxdvb_satconf_class,
-  .ic_caption     = N_("DiseqC rotor"),
+  .ic_caption     = N_("TV Adapters - SatConfig - DiseqC Rotor"),
   .ic_get_title   = linuxdvb_rotor_class_get_title,
   .ic_properties  = (const property_t[]) {
     {
       .type    = PT_U32,
       .id      = "powerup_time",
       .name    = N_("Power-up time (ms) (15-200)"),
+      .desc    = N_("Time (in milliseconds) for the rotor to power up."),
       .off     = offsetof(linuxdvb_rotor_t, lr_powerup_time),
       .def.u32 = 100,
     },
     {
       .type    = PT_U32,
       .id      = "cmd_time",
       .name    = N_("Command time (ms) (10-100)"),
+      .desc    = N_("Time (in milliseconds) for a command to complete."),
       .off     = offsetof(linuxdvb_rotor_t, lr_cmd_time),
       .def.u32 = 25
     },
@@ -117,18 +119,20 @@ const idclass_t linuxdvb_rotor_gotox_class =
 {
   .ic_super       = &linuxdvb_rotor_class,
   .ic_class       = "linuxdvb_rotor_gotox",
-  .ic_caption     = N_("GOTOX rotor"),
+  .ic_caption     = N_("TV Adapters - SatConfig - GOTOX Rotor"),
   .ic_properties  = (const property_t[]) {
     {
       .type   = PT_U16,
       .id     = "position",
       .name   = N_("GOTOX position"),
+      .desc   = N_("Satellite position."),
       .off    = offsetof(linuxdvb_rotor_t, lr_position),
     },
     {
       .type   = PT_DBL,
       .id     = "sat_lon",
       .name   = N_("Satellite longitude"),
+      .desc   = N_("Satellite longitude."),
       .off    = offsetof(linuxdvb_rotor_t, lr_sat_lon),
     },
     {}
@@ -139,12 +143,13 @@ const idclass_t linuxdvb_rotor_usals_class =
 {
   .ic_super       = &linuxdvb_rotor_class,
   .ic_class       = "linuxdvb_rotor_usals",
-  .ic_caption     = N_("USALS rotor"),
+  .ic_caption     = N_("TV Adapters - SatConfig - USALS Rotor"),
   .ic_properties  = (const property_t[]) {
     {
       .type   = PT_DBL,
       .id     = "sat_lon",
       .name   = N_("Satellite longitude"),
+      .desc   = N_("Satellite longitude."),
       .off    = offsetof(linuxdvb_rotor_t, lr_sat_lon),
     },
 

diff --git a/src/input/mpegts/linuxdvb/linuxdvb_satconf.c b/src/input/mpegts/linuxdvb/linuxdvb_satconf.c
@@ -214,7 +214,7 @@ CLASS_DOC(linuxdvb_satconf) /* Referenced by multiple classes. */
 const idclass_t linuxdvb_satconf_class =
 {
   .ic_class      = "linuxdvb_satconf",
-  .ic_caption    = N_("DVB-S satellite configuration"),
+  .ic_caption    = N_("DVB-S Satellite Configuration"),
   .ic_event      = "linuxdvb_satconf",
   .ic_get_title  = linuxdvb_satconf_class_get_title,
   .ic_doc        = tvh_doc_linuxdvb_satconf_class,
@@ -281,7 +281,7 @@ const idclass_t linuxdvb_satconf_lnbonly_class =
   .ic_super      = &linuxdvb_satconf_class,
   .ic_class      = "linuxdvb_satconf_lnbonly",
   .ic_doc        = tvh_doc_linuxdvb_satconf_class,
-  .ic_caption    = N_("DVB-S simple"),
+  .ic_caption    = N_("TV Adapters - SatConfig - Universal LNB (Simple)"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -307,7 +307,7 @@ const idclass_t linuxdvb_satconf_2port_class =
   .ic_super      = &linuxdvb_satconf_class,
   .ic_class      = "linuxdvb_satconf_2port",
   .ic_doc        = tvh_doc_linuxdvb_satconf_class,
-  .ic_caption    = N_("DVB-S tone burst"),
+  .ic_caption    = N_("TV Adapters - SatConfig - Tone Burst/2 Port"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -345,7 +345,7 @@ const idclass_t linuxdvb_satconf_4port_class =
   .ic_super      = &linuxdvb_satconf_class,
   .ic_class      = "linuxdvb_satconf_4port",
   .ic_doc        = tvh_doc_linuxdvb_satconf_class,
-  .ic_caption    = N_("DVB-S 4-port"),
+  .ic_caption    = N_("TV Adapters - SatConfig - 4-Port"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_STR,
@@ -464,7 +464,7 @@ const idclass_t linuxdvb_satconf_en50494_class =
   .ic_super      = &linuxdvb_satconf_class,
   .ic_class      = "linuxdvb_satconf_en50494",
   .ic_doc        = tvh_doc_linuxdvb_satconf_class,
-  .ic_caption    = N_("DVB-S EN50494 (UniCable, experimental)"),
+  .ic_caption    = N_("TV Adapters - SatConfig - EN50494/UniCable (experimental)"),
   .ic_properties = (const property_t[]) {
     {
       .type     = PT_U16,
@@ -531,7 +531,7 @@ const idclass_t linuxdvb_satconf_advanced_class =
   .ic_super      = &linuxdvb_satconf_class,
   .ic_class      = "linuxdvb_satconf_advanced",
   .ic_doc        = tvh_doc_linuxdvb_satconf_class,
-  .ic_caption    = N_("DVB-S advanced"),
+  .ic_caption    = N_("TV Adapters - SatConfig - Advanced"),
   .ic_get_childs = linuxdvb_satconf_class_get_childs,
   .ic_properties = (const property_t[]) {
     {

diff --git a/src/input/mpegts/linuxdvb/linuxdvb_switch.c b/src/input/mpegts/linuxdvb/linuxdvb_switch.c
@@ -115,7 +115,7 @@ const idclass_t linuxdvb_switch_class =
 {
   .ic_super       = &linuxdvb_diseqc_class,
   .ic_class       = "linuxdvb_switch",
-  .ic_caption     = N_("DiseqC switch"),
+  .ic_caption     = N_("TV Adapters - SatConfig - DiseqC Switch"),
   .ic_doc         = tvh_doc_linuxdvb_satconf_class,
   .ic_get_title   = linuxdvb_switch_class_get_title,
   .ic_properties  = (const property_t[]) {