fix doxygen documentation.

[vlc] / modules / control / http / http.h

diff --git a/modules/control/http/http.h b/modules/control/http/http.h
index 9f550237002afa73d4382377108f9f233c5155fe..3b2381b8479214916b3c6e2c3e67184bcb1e6df9 100644 (file)
--- a/modules/control/http/http.h
+++ b/modules/control/http/http.h
@@ -39,18 +39,16 @@
 #include <vlc_aout.h>
 #include <vlc_vout.h> /* for fullscreen */
 
-#include "vlc_httpd.h"
-#include "vlc_vlm.h"
-#include "vlc_network.h"
-#include "vlc_acl.h"
-#include "vlc_charset.h"
+#include <vlc_httpd.h>
+#include <vlc_vlm.h>
+#include <vlc_network.h>
+#include <vlc_acl.h>
+#include <vlc_charset.h>
 
 #ifdef HAVE_SYS_STAT_H
 #   include <sys/stat.h>
 #endif
-#ifdef HAVE_ERRNO_H
-#   include <errno.h>
-#endif
+#include <errno.h>
 #ifdef HAVE_FCNTL_H
 #   include <fcntl.h>
 #endif
@@ -108,7 +106,7 @@ int FileLoad( FILE *f, char **pp_data, int *pi_data );
 /** This function creates a suitable URL for a filename */
 char *FileToUrl( char *name, bool *pb_index );
 /** This function returns the real path of a file or directory */
-char *RealPath( intf_thread_t *p_intf, const char *psz_src );
+char *RealPath( const char *psz_src );
 
 /** This command parses the "seek" command for the HTTP interface
  * and performs the requested action */
@@ -118,16 +116,16 @@ void HandleSeek( intf_thread_t *p_intf, char *p_value );
 
 /** This function extracts the value for a given argument name
  * from an HTTP request */
-char *ExtractURIValue( char *restrict psz_uri,
+const char *ExtractURIValue( const char *restrict psz_uri,
                            const char *restrict psz_name,
                            char *restrict psz_value, size_t i_value_max );
-char *ExtractURIString( char *restrict psz_uri,
+char *ExtractURIString( const char *restrict psz_uri,
                             const char *restrict psz_name );
 /** \todo Describe this function */
 int TestURIParam( char *psz_uri, const char *psz_name );
 
 /** This function parses a MRL */
-input_item_t *MRLParse( intf_thread_t *, char *psz, char *psz_name );
+input_item_t *MRLParse( intf_thread_t *, const char *psz, char *psz_name );
 
 /** Return the first word from a string (works in-place) */
 char *FirstWord( char *psz, char *new );
@@ -177,7 +175,7 @@ void     mvar_RemoveVar( mvar_t *v, mvar_t *f );
 /** This function retrieves the child variable named "name" */
 mvar_t  *mvar_GetVar( mvar_t *s, const char *name );
 /** This function retrieves the value of the child variable named "field" */
-char    *mvar_GetValue( mvar_t *v, char *field );
+const char *mvar_GetValue( mvar_t *v, const char *field );
 /** This function creates a variable with the given name and value and
  * adds it as first child of vars */
 void     mvar_PushNewVar( mvar_t *vars, const char *name,
@@ -303,7 +301,7 @@ void Execute( httpd_file_sys_t *p_args,
 /**
  * Core stuff
  */
-/** \struct
+/** \struct httpd_file_sys_t
  * This structure represent a single HTML file to be parsed by the macros
  * handling engine */
 struct httpd_file_sys_t
@@ -323,7 +321,7 @@ struct httpd_file_sys_t
     mvar_t        *vars;
 };
 
-/** \struct
+/** \struct http_association_t
  * Structure associating an extension to an external program
  */
 typedef struct http_association_t
@@ -333,7 +331,7 @@ typedef struct http_association_t
     char                **ppsz_argv;
 } http_association_t;
 
-/** \struct
+/** \struct httpd_handler_sys_t
  * This structure represent a single CGI file to be parsed by the macros
  * handling engine */
 struct httpd_handler_sys_t
@@ -346,7 +344,7 @@ struct httpd_handler_sys_t
     http_association_t *p_association;
 };
 
-/** \struct
+/** \struct intf_sys_t
  * Internal service structure for the HTTP interface
  */
 struct intf_sys_t