NextPVR Forums
  • ______
  • Home
  • New Posts
  • Wiki
  • Members
  • Help
  • Search
  • Register
  • Login
  • Home
  • Wiki
  • Members
  • Help
  • Search
NextPVR Forums Public Developers v
« Previous 1 … 7 8 9 10 11 … 93 Next »
API docs to help with plugin development?

 
  • 0 Vote(s) - 0 Average
API docs to help with plugin development?
McBainUK
Offline

Posting Freak

Posts: 4,711
Threads: 429
Joined: Sep 2005
#1
2011-09-19, 12:52 PM
Sub, have you considered creating Ghost Doc .chm files from the public interfaces and clases that plugin developers would be expected to commonly use? This can be a very easy way of creating reasonable documentation if the source files are already XML commeted?

background: I've been looking at the Plugin Development section of the wiki, especially the (work in progress) API Reference section.
Wiki profile
My Projects
Programs Plugin [SIZE=2](retired)
| Volume OSD Plugin (retired) | Documentation Wiki (retired)
[/SIZE]
sub
Offline

Administrator

NextPVR HQ, New Zealand
Posts: 106,661
Threads: 767
Joined: Nov 2003
#2
2011-09-19, 04:14 PM
Maybe in the future. Currently the comments on the method descriptions are very brief, and dont define the parameters or return types, so wouldnt be useable for this purpose.
McBainUK
Offline

Posting Freak

Posts: 4,711
Threads: 429
Joined: Sep 2005
#3
2013-06-08, 09:13 AM
Did you have any more thoughts on this?
Wiki profile
My Projects
Programs Plugin [SIZE=2](retired)
| Volume OSD Plugin (retired) | Documentation Wiki (retired)
[/SIZE]
sub
Offline

Administrator

NextPVR HQ, New Zealand
Posts: 106,661
Threads: 767
Joined: Nov 2003
#4
2013-06-08, 06:14 PM
As much as I hate to admit it, there really isn't enough comments on those interfaces to generate useful documentation.
« Next Oldest | Next Newest »

Users browsing this thread: 1 Guest(s)



Possibly Related Threads…
Thread Author Replies Views Last Post
  PIP plugin for Kodi sgilani 2 2,767 2022-10-17, 12:44 AM
Last Post: sgilani
  New Systems Plugin kirschey 10 3,315 2020-11-14, 08:01 PM
Last Post: sub
  Test/Development environment for npvr.db3 scJohn 10 4,225 2020-09-04, 09:14 PM
Last Post: scJohn
  VIdeo playback from plugin mvallevand 5 3,431 2015-08-06, 10:43 PM
Last Post: sub
  Attention Sub: Open TV / Custom Data Grabber plugin Benoire 2 2,869 2014-11-14, 02:05 AM
Last Post: Benoire
  Refreshing TV Guide Data (after System plugin EPG update) imilne 13 6,048 2013-03-24, 08:03 PM
Last Post: imilne
  sabnzbd plugin to show processed files Wakalaka 1 1,938 2013-03-12, 06:48 AM
Last Post: psycik
  Integrated Development Environment (IDE) for plugins osx-addict 5 2,727 2012-10-18, 08:35 PM
Last Post: osx-addict
  Plugin problems with started from the command line mvallevand 11 4,959 2012-08-12, 07:56 PM
Last Post: sub
  Get NextPVR data directory from outside a plugin McBainUK 3 2,224 2012-02-11, 05:42 PM
Last Post: mvallevand

  • View a Printable Version
  • Subscribe to this thread
Forum Jump:

© Designed by D&D, modified by NextPVR - Powered by MyBB

Linear Mode
Threaded Mode