diff options
| author | Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> | 2001-07-26 11:12:25 +0000 |
|---|---|---|
| committer | Daniel Caujolle-Bert <f1rmb@users.sourceforge.net> | 2001-07-26 11:12:25 +0000 |
| commit | a101b38dea6890fa1dbf5b8560665826b69fa4ae (patch) | |
| tree | 2615e691684c22951ebb881d6a5009257aad2f97 /doc/man/en/man3/xine_version.3 | |
| parent | 4042284ccba79fe453dfca7b4d45edba31d36d48 (diff) | |
| download | xine-lib-a101b38dea6890fa1dbf5b8560665826b69fa4ae.tar.gz xine-lib-a101b38dea6890fa1dbf5b8560665826b69fa4ae.tar.bz2 | |
Updated doxy sections in xine.h.tmpl.in. Added man3. Removed french man page. Added API doc in html. Add new rpm package (doc). Fixes some little bugs in
proto decl, etc...
CVS patchset: 350
CVS date: 2001/07/26 11:12:25
Diffstat (limited to 'doc/man/en/man3/xine_version.3')
| -rw-r--r-- | doc/man/en/man3/xine_version.3 | 108 |
1 files changed, 108 insertions, 0 deletions
diff --git a/doc/man/en/man3/xine_version.3 b/doc/man/en/man3/xine_version.3 new file mode 100644 index 000000000..6256448a0 --- /dev/null +++ b/doc/man/en/man3/xine_version.3 @@ -0,0 +1,108 @@ +.TH "Version functions" 3 "26 Jul 2001" "XINE, A Free Video Player Project - API reference" \" -*- nroff -*- +.ad l +.nh +.SH NAME +Version functions \- +.SS "Functions" + +.in +1c +.ti -1c +.RI "char* \fBxine_get_str_version\fP (void)" +.br +.RI "\fIreturn string version, like '0.5.0'.\fP" +.ti -1c +.RI "int \fBxine_get_major_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_get_minor_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_get_sub_version\fP (void)" +.br +.RI "\fIreturn version information.\fP" +.ti -1c +.RI "int \fBxine_check_version\fP (int major, int minor, int sub)" +.br +.RI "\fIcheck minimal version.\fP" +.in -1c +.SH "FUNCTION DOCUMENTATION" +.PP +.SS "int xine_check_version (int major, int minor, int sub)" +.PP +check minimal version. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fImajor\fP\fP +major version wanted. +.TP +\fB\fIminorr\fP\fP +minor version wanted. +.TP +\fB\fIsub\fP\fP +sub version wanted. +.PP +\fBReturns: \fP +.in +1c +1 if installed version is >= to desired, otherwise 0 +.PP +Compare version numbers with xine installed version. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fImajor\fP\fP + +.TP +\fB\fIminor\fP\fP + +.TP +\fB\fIsub\fP\fP + +.SS "int xine_get_major_version (void)" +.PP +return version information. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +major version. +.SS "int xine_get_minor_version (void)" +.PP +return version information. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +minor version. +.SS "char * xine_get_str_version (void)" +.PP +return string version, like '0.5.0'. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +string version +.SS "int xine_get_sub_version (void)" +.PP +return version information. +.PP +\fBParameters: \fP +.in +1c +.TP +\fB\fINone.\fP\fP +\fBReturns: \fP +.in +1c +sub version.
\ No newline at end of file |