[vlc-commits] macosx: Use doxygen comments in VLCScrollingClipView

[Marvin Scholz]

vlc | branch: master | Marvin Scholz <epirat07 at gmail.com> | Sun Jul 23 17:19:04 2017 +0200| [54100f01b2027148df79810cc01a2962985542d9] | committer: Marvin Scholz

macosx: Use doxygen comments in VLCScrollingClipView

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=54100f01b2027148df79810cc01a2962985542d9
---

 modules/gui/macosx/VLCScrollingClipView.h | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)

diff --git a/modules/gui/macosx/VLCScrollingClipView.h b/modules/gui/macosx/VLCScrollingClipView.h
index efaf366b6d..e0f5d2b233 100644
--- a/modules/gui/macosx/VLCScrollingClipView.h
+++ b/modules/gui/macosx/VLCScrollingClipView.h
@@ -21,20 +21,35 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+/**
+ A Clip view subclass that offers automatic scrolling of its contents.
+ */
+
 #import <Cocoa/Cocoa.h>
 
 @interface VLCScrollingClipView : NSClipView
 
-/* Start scrolling. Does nothing if already scrolling. */
+/**
+ \brief Start automatic scrolling
+
+ \note  Does nothing if already scrolling
+ */
 - (void)startScrolling;
 
-/* Stop scrolling. Does not reset the position! */
+/**
+ Stop automatic scrolling.
+
+ \note  Does not reset the position */
 - (void)stopScrolling;
 
-/* Resets scrolling position to the top */
+/**
+ Reset scrolling position to the top
+ */
 - (void)resetScrolling;
 
-/* Outlet to the parent NSScrollView */
+/**
+ Outlet to the parent NSScrollView
+ */
 @property IBOutlet NSScrollView *parentScrollView;
 
 @end