Fix a few Doxygen warnings
[yaz-moved-to-github.git] / include / yaz / proto.h
index 7c40f0e..1cb0750 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of the YAZ toolkit.
- * Copyright (C) 1995-2010 Index Data.
+ * Copyright (C) 1995-2013 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:
@@ -44,6 +44,7 @@
 #include <yaz/z-espec1.h>
 #include <yaz/z-estask.h>
 #include <yaz/z-exp.h>
+#include <yaz/z-facet-1.h>
 #include <yaz/z-grs.h>
 #include <yaz/z-opac.h>
 #include <yaz/z-rrf1.h>
@@ -87,14 +88,14 @@ YAZ_BEGIN_CDECL
 #define Z_RES_INTERIM Z_SearchResponse_interim
 #define Z_RES_NONE    Z_SearchResponse_none
 
-#define Z_SortStatus_success Z_SortResponse_success 
+#define Z_SortStatus_success Z_SortResponse_success
 #define Z_SortStatus_partial_1 Z_SortResponse_partial_1
 #define Z_SortStatus_failure Z_SortResponse_failure
 
-#define Z_SortRelation_ascending            Z_SortKeySpec_ascending 
+#define Z_SortRelation_ascending            Z_SortKeySpec_ascending
 #define Z_SortRelation_descending           Z_SortKeySpec_descending
 #define Z_SortRelation_ascendingByFreq      Z_SortKeySpec_ascendingByFrequency
-#define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency 
+#define Z_SortRelation_descendingByFreq     Z_SortKeySpec_descendingByfrequency
 
 #define Z_SortCase_caseSensitive            Z_SortKeySpec_caseSensitive
 #define Z_SortCase_caseInsensitive          Z_SortKeySpec_caseInsensitive
@@ -184,6 +185,13 @@ const char *yaz_get_esn(Z_RecordComposition *comp);
 YAZ_EXPORT
 void yaz_set_esn(Z_RecordComposition **comp_p, const char *esn, NMEM nmem);
 
+/** \brief returns diagnostics from an init response
+    \param no number of diagnotic entry to get. 0=first, 1=second, ..
+    \param initrs InitResponse structure
+    \returns diag entry or 0 (NULL) if none could be found
+*/
+YAZ_EXPORT
+Z_DefaultDiagFormat *yaz_decode_init_diag(int no, Z_InitResponse *initrs);
 
 YAZ_END_CDECL