mdhelp: add markdown for autorec/timerec/dvrconfig

tvheadend · Apr 6, 2016 · e6bab99 · e6bab99
1 parent a4afbee
commit e6bab99
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 0 deletions.
diff --git a/docs/class/dvrautorec.md b/docs/class/dvrautorec.md
@@ -0,0 +1,11 @@
+##Digital Video Recorder - Autorec
+
+This tab is used to create and maintain Digital Video Recorder rules.
+These can be EPG-driven (such as those created from the initial EPG tab)
+through the DVR AutoRec Entries tab , or can be timer-based through the
+Time Schedules tab.
+
+This tab controls EPG-driven recording rules.
+
+!['Autorec' Tab](docresources/dvrautorecentries.png)
+
diff --git a/docs/class/dvrconfig.md b/docs/class/dvrconfig.md
@@ -0,0 +1,8 @@
+##Configuration - Recording - Digital Video Recorder Profiles
+
+This tab is used to configure operation of the Digital Video Recorder.
+It is not used for scheduling or administration of individual
+recordings.
+
+!['Digital Video Recorder Profiles' Tab 1](docresources/configdvrtab.png)
+
diff --git a/docs/class/dvrtimerec.md b/docs/class/dvrtimerec.md
@@ -0,0 +1,10 @@
+##Digital Video Recorder - Time Schedules
+
+This tab is used to create and maintain Digital Video Recorder rules.
+These can be EPG-driven (such as those created from the initial EPG tab)
+through the DVR AutoRec Entries tab , or can be timer-based through the
+Time Schedules tab.
+
+This tab controls timer-driven recording rules.
+
+![Time Schedules Tab](docresources/timeschedules.png)
diff --git a/src/dvr/dvr_autorec.c b/src/dvr/dvr_autorec.c
@@ -978,10 +978,13 @@ dvr_autorec_entry_class_owner_opts(void *o)
   return PO_RDONLY | PO_ADVANCED;
 }
 
+extern const char *tvh_doc_dvrautorec_class[];
+
 const idclass_t dvr_autorec_entry_class = {
   .ic_class      = "dvrautorec",
   .ic_caption    = N_("DVR Auto-record entry"),
   .ic_event      = "dvrautorec",
+  .ic_doc        = tvh_doc_dvrautorec_class,
   .ic_changed    = dvr_autorec_entry_class_changed,
   .ic_save       = dvr_autorec_entry_class_save,
   .ic_get_title  = dvr_autorec_entry_class_get_title,

diff --git a/src/dvr/dvr_config.c b/src/dvr/dvr_config.c
@@ -791,10 +791,13 @@ dvr_config_class_pathname_set(void *o, const void *v)
   return 0;
 }
 
+extern const char *tvh_doc_dvrconfig_class[];
+
 const idclass_t dvr_config_class = {
   .ic_class      = "dvrconfig",
   .ic_caption    = N_("DVR configuration profile"),
   .ic_event      = "dvrconfig",
+  .ic_doc        = tvh_doc_dvrconfig_class,
   .ic_changed    = dvr_config_class_changed,
   .ic_save       = dvr_config_class_save,
   .ic_get_title  = dvr_config_class_get_title,

diff --git a/src/dvr/dvr_timerec.c b/src/dvr/dvr_timerec.c
@@ -514,10 +514,13 @@ dvr_timerec_entry_class_owner_opts(void *o)
   return PO_RDONLY | PO_ADVANCED;
 }
 
+extern const char *tvh_doc_dvrtimerec_class[];
+
 const idclass_t dvr_timerec_entry_class = {
   .ic_class      = "dvrtimerec",
   .ic_caption    = N_("DVR time record entry"),
   .ic_event      = "dvrtimerec",
+  .ic_doc        = tvh_doc_dvrtimerec_class,
   .ic_changed    = dvr_timerec_entry_class_changed,
   .ic_save       = dvr_timerec_entry_class_save,
   .ic_get_title  = dvr_timerec_entry_class_get_title,