Add a bunch of \file doxygen comments

[vlc] / include / vlc_sout.h

diff --git a/include/vlc_sout.h b/include/vlc_sout.h
index 657b43bee3348f44c4909e9f49690a77221c4b53..811146f72baef197e8d5936c8183f4e35d476a61 100644 (file)
--- a/include/vlc_sout.h
+++ b/include/vlc_sout.h
@@ -24,12 +24,13 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_SOUT_H_
+#define VLC_SOUT_H_
 
-#ifndef _VLC_SOUT_H_
-#define _VLC_SOUT_H_
+/**
+ * \file
+ * This file defines structures and functions for stream ouput in vlc
+ */
 
 #ifdef __cplusplus
 extern "C" {
@@ -235,7 +236,7 @@ VLC_EXPORT(void,                 sout_MethodRelease, (announce_method_t *) );
 
 VLC_EXPORT( char *, vlc_sdp_Start, ( vlc_object_t *obj, const char *cfgpref, const struct sockaddr *src, size_t srclen, const struct sockaddr *addr, size_t addrlen ) );
 VLC_EXPORT( char *, sdp_AddMedia, (char **sdp, const char *type, const char *protocol, int dport, unsigned pt, bool bw_indep, unsigned bw, const char *ptname, unsigned clockrate, unsigned channels, const char *fmtp) );
-VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) ATTRIBUTE_FORMAT( 3, 4 ) );
+VLC_EXPORT( char *, sdp_AddAttribute, (char **sdp, const char *name, const char *fmt, ...) LIBVLC_FORMAT( 3, 4 ) );
 
 
 #ifdef __cplusplus