X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fsc.h;h=f8c44d8f6bc56a4cfa2b8293932f1c8271013963;hp=1889e1dd4b025a4d60792e505ee47797b684fc0e;hb=32790840d73b1f4a4bde1478e6b14699aac00e94;hpb=540056f9cf1a3304b253db09eba899cc6763466d

diff --git a/include/yaz/sc.h b/include/yaz/sc.h
index 1889e1d..f8c44d8 100644
--- a/include/yaz/sc.h
+++ b/include/yaz/sc.h
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2008 Index Data.
+ * Copyright (C) Index Data.
  * All rights reserved.
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are met:
@@ -25,27 +25,55 @@
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-/**
- * \file sc.h
- * \brief Header for Windows Service Control stuff
- */
+/** \file sc.h
+    \brief Header for Windows Service Control utility
 
+    This is a simple wrapper for the Windows Service Control system. It
+    also operates on Unix in which case the user supplied main function
+    (sc_main) is is called immediately. See sc_test.c for an example.
+ */
 
 #include <yaz/yconfig.h>
 
 YAZ_BEGIN_CDECL
 
+/** service control handle (opaque type) */
 typedef struct sc_s *yaz_sc_t;
 
+/** \brief creates service handle
+    \param service_name Service Name
+    \param display_name Display Name
+    \return service control handle
+
+    This function does not activate the service. Only creates handle.
+*/
 YAZ_EXPORT yaz_sc_t yaz_sc_create(const char *service_name,
                                   const char *display_name);
 
-YAZ_EXPORT void yaz_sc_running(yaz_sc_t s);
+/** \brief registers service controlled program
+    \param s service control handle
+    \param argc argc as given from main
+    \param argv argv as given from main
+    \param sc_main service main function
+    \param sc_stop service stop function
+    \return sc_main return value
 
+    sc_main is the main program of the application. It should initialize
+    the application.. Function yaz_sc_running MUST be called before
+    the application operates (after initialization)
+*/
 YAZ_EXPORT int yaz_sc_program(yaz_sc_t s, int argc, char **argv,
 	 		      int (*sc_main)(yaz_sc_t s, int argc, char **argv),
 			      void (*sc_stop)(yaz_sc_t s));
 
+/** \brief signals that sc_main applicatio starts running
+    \param s service control handle
+*/
+YAZ_EXPORT void yaz_sc_running(yaz_sc_t s);
+
+/** \brief frees service control handle
+    \param s service control handle
+*/
 YAZ_EXPORT void yaz_sc_destroy(yaz_sc_t *s);
 
 YAZ_END_CDECL
@@ -53,6 +81,7 @@ YAZ_END_CDECL
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab