]> git.ipfire.org Git - thirdparty/samba.git/commitdiff
libwbclient: Fixed doxygen errors.
authorAndreas Schneider <asn@samba.org>
Wed, 5 May 2010 13:33:09 +0000 (15:33 +0200)
committerAndreas Schneider <asn@samba.org>
Wed, 5 May 2010 13:36:10 +0000 (15:36 +0200)
nsswitch/libwbclient/wbc_sid_async.c
nsswitch/libwbclient/wbclient.c
nsswitch/libwbclient/wbclient.h

index b94b88d491d428193130e7ce0fe6e30ca9038b84..828e3b449784c1303a89ede99c21a0b551beee92 100644 (file)
@@ -36,7 +36,7 @@ struct wbc_lookup_name_state {
 static void wbcLookupName_done(struct tevent_req *subreq);
 
 /**
- * @brief Request a conversion of a domaind and name to a domain sid
+ * @brief Request a conversion of a domain and name to a domain sid
  *
  * @param mem_ctx      talloc context to allocate the request from
  * @param ev           tevent context to use for async operation
@@ -118,15 +118,16 @@ static void wbcLookupName_done(struct tevent_req *subreq)
 }
 
 /**
- * @brief Receive a conversion a SID to a domain and name
+ * @brief Receive a conversion of a domain and name to a domain SID.
+ *
+ * @param req The tevent request calling this function.
+ *
+ * @param sid A pointer to store the sid looked up.
  *
- * @param *
- * @param *pname       Resolved User or group name
- * @param *pname_type  Pointer to the resolved SID type
+ * @param name_type Pointer to store the resolved SID name type.
  *
  * @return #wbcErr
  */
-
 wbcErr wbcLookupName_recv(struct tevent_req *req,
                          struct wbcDomainSid *sid,
                          enum wbcSidType *name_type)
@@ -245,14 +246,19 @@ static void wbcLookupSid_done(struct tevent_req *subreq)
 /**
  * @brief Receive a conversion a SID to a domain and name
  *
- * @param *mem_ctx,    talloc context to move results to
- * @param *pdomain     Resolved Domain name (possibly "")
- * @param *pname       Resolved User or group name
- * @param *pname_type  Pointer to the resolved SID type
+ * @param req          The tevent request calling this function.
+ *
+ * @param mem_ctx      A talloc context to move results to.
+ *
+ * @param pdomain      A pointer to store the resolved domain name
+ *                      (possibly "").
+ *
+ * @param pname        A pointer to store the resolved user or group name.
+ *
+ * @param pname_type   A pointer to store the resolved SID type.
  *
  * @return #wbcErr
  */
-
 wbcErr wbcLookupSid_recv(struct tevent_req *req,
                         TALLOC_CTX *mem_ctx,
                         char **pdomain,
index 2792827bd5eaa791fad9e8bfab6dd7e439c5ac60..15be255d45de33df57579ade614fd907d0b0c79f 100644 (file)
@@ -34,16 +34,7 @@ NSS_STATUS winbindd_priv_request_response(int req_type,
                                          struct winbindd_request *request,
                                          struct winbindd_response *response);
 
-/** @brief Wrapper around Winbind's send/receive API call
- *
- * @param cmd       Winbind command operation to perform
- * @param request   Send structure
- * @param response  Receive structure
- *
- * @return #wbcErr
- **/
-
-/**********************************************************************
+/*
  result == NSS_STATUS_UNAVAIL: winbind not around
  result == NSS_STATUS_NOTFOUND: winbind around, but domain missing
 
@@ -54,7 +45,7 @@ NSS_STATUS winbindd_priv_request_response(int req_type,
  (as far as I have seen) with the callers of is_trusted_domains.
 
  --Volker
-**********************************************************************/
+*/
 
 static wbcErr wbcRequestResponseInt(
        int cmd,
@@ -89,6 +80,15 @@ static wbcErr wbcRequestResponseInt(
        return wbc_status;
 }
 
+/**
+ * @brief Wrapper around Winbind's send/receive API call
+ *
+ * @param cmd       Winbind command operation to perform
+ * @param request   Send structure
+ * @param response  Receive structure
+ *
+ * @return #wbcErr
+ */
 wbcErr wbcRequestResponse(int cmd,
                          struct winbindd_request *request,
                          struct winbindd_response *response)
index 718c9f6885c46a6332330b5b814fce988590bdb3..e2f989094aaf740b134b5338a4977d0f7e4ca44d 100644 (file)
@@ -982,13 +982,14 @@ wbcErr wbcGetGroups(const char *account,
 /**
  * @brief Lookup the current status of a trusted domain
  *
- * @param domain      Domain to query
- * @param *info       Pointer to returned domain_info struct
+ * @param domain        The domain to query
+ *
+ * @param dinfo          A pointer to store the returned domain_info struct.
  *
  * @return #wbcErr
  **/
 wbcErr wbcDomainInfo(const char *domain,
-                    struct wbcDomainInfo **info);
+                    struct wbcDomainInfo **dinfo);
 
 /**
  * @brief Enumerate the domain trusts known by Winbind