From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-lf0-f66.google.com (mail-lf0-f66.google.com [209.85.215.66]) by dpdk.org (Postfix) with ESMTP id 9E93C5A72 for ; Wed, 19 Oct 2016 02:33:17 +0200 (CEST) Received: by mail-lf0-f66.google.com with SMTP id x23so525653lfi.1 for ; Tue, 18 Oct 2016 17:33:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id; bh=+updRVrJ5K14O+mFxxTkXa3mSYJyxLRow4P/fsRqMOU=; b=FMnSuaGvxAClIuK1VLTvdhlSGeDQikLk0o5W43u1KGPf4rnUn/YklxskboIV8MRnk3 QXYqiPljAiB5SPcs89dGNzj6IGRHdLPK/zW9ZLqPP61ZcWd/FexVfQkcasn/qN7O2ziW ELxKaUjYfVGb1N63DhGMXIjOZeQ4hfqM3/mgIxgvhtaw8ofUUXufuRukq9LgqFB7WZgQ eqqFnmXejegylamQ67j1L+8q9T9D61Pn2VmfdwLVxVRTAUwkKheV/A/OoMsxrfLtosMs IR2yMNjKZ0cgZWrHxYCbrA9Te8mjrZR0UHfEa9X6xwAHiI0YsKrXH67tIFnqNQ9E5NuN 90iA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=+updRVrJ5K14O+mFxxTkXa3mSYJyxLRow4P/fsRqMOU=; b=Jz1KGSno2H3uAri5cu5WRArF+1hd5KLKT7wWMsJXwPwQWQ980pHewZwoeqnTvyAK06 LIC5EGruXRXxi02CytRYXzsFNOlCbkWn/7jZWur2xpWDZEVncUf/aG6MlZzNynosnU/5 KeiCX0eVOMwpEca/fv5aQzMecSE1hxvahEY3Hl3u1LMyjG7I4Laia6E95mIfxD0J+vDW m3Q8Y9jGky+1ZgdUOA/o9+HG2fC2DDfWDTOiPlAGJCvhFiYKmtbLIn8PU2qjEYWE/sAm u1RHUEGQzX6nKQvfOgkZiCWOcdpmmsqf5WOBGQf9DLEIj6oGSj3G0/YaWNxWxBLG7MkO /zhw== X-Gm-Message-State: AA6/9RljotIrfTB7wLWGZF/AWcOU7ITge8GCtfCmnPCyK4TkCRNO0+l1v+ebkWwcdhcadg== X-Received: by 10.25.32.67 with SMTP id g64mr2345211lfg.180.1476837197087; Tue, 18 Oct 2016 17:33:17 -0700 (PDT) Received: from BombermaG-LHOME.lan ([62.122.211.100]) by smtp.gmail.com with ESMTPSA id x16sm10150621lff.15.2016.10.18.17.33.16 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 18 Oct 2016 17:33:16 -0700 (PDT) From: Dmitriy Yakovlev To: dev@dpdk.org Cc: Dmitriy Yakovlev Date: Wed, 19 Oct 2016 03:33:03 +0300 Message-Id: <1476837183-27163-1-git-send-email-bombermag@gmail.com> X-Mailer: git-send-email 1.9.1 Subject: [dpdk-dev] [PATCH] cfgfile: fix comments - style and return value X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 19 Oct 2016 00:33:18 -0000 Fixed style and return values in Doxygen comments. Signed-off-by: Dmitriy Yakovlev --- lib/librte_cfgfile/rte_cfgfile.h | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/lib/librte_cfgfile/rte_cfgfile.h b/lib/librte_cfgfile/rte_cfgfile.h index e81a5a2..735e022 100644 --- a/lib/librte_cfgfile/rte_cfgfile.h +++ b/lib/librte_cfgfile/rte_cfgfile.h @@ -88,7 +88,7 @@ struct rte_cfgfile *rte_cfgfile_load(const char *filename, int flags); * @param length * Maximum section name length * @return -* 0 on success, error code otherwise +* Number of sections */ int rte_cfgfile_num_sections(struct rte_cfgfile *cfg, const char *sec_name, size_t length); @@ -102,13 +102,13 @@ int rte_cfgfile_num_sections(struct rte_cfgfile *cfg, const char *sec_name, * @param cfg * Config file * @param sections -* Array containing section names after successful invocation. Each elemen +* Array containing section names after successful invocation. Each element * of this array should be preallocated by the user with at least * CFG_NAME_LEN characters. * @param max_sections * Maximum number of section names to be stored in sections array * @return -* 0 on success, error code otherwise +* Number of populated sections names */ int rte_cfgfile_sections(struct rte_cfgfile *cfg, char *sections[], int max_sections); @@ -136,12 +136,13 @@ int rte_cfgfile_has_section(struct rte_cfgfile *cfg, const char *sectionname); * @param sectionname * Section name * @return -* Number of entries in section +* Number of entries in section on success, -1 otherwise */ int rte_cfgfile_section_num_entries(struct rte_cfgfile *cfg, const char *sectionname); -/** Get section entries as key-value pairs +/** +* Get section entries as key-value pairs * * If multiple sections have the given name this function operates on the * first one. @@ -156,14 +157,15 @@ int rte_cfgfile_section_num_entries(struct rte_cfgfile *cfg, * @param max_entries * Maximum number of section entries to be stored in entries array * @return -* 0 on success, error code otherwise +* Number of entries populated on success, -1 otherwise */ int rte_cfgfile_section_entries(struct rte_cfgfile *cfg, const char *sectionname, struct rte_cfgfile_entry *entries, int max_entries); -/** Get section entries as key-value pairs +/** +* Get section entries as key-value pairs * * The index of a section is the same as the index of its name in the * result of rte_cfgfile_sections. This API can be used when there are @@ -182,7 +184,7 @@ int rte_cfgfile_section_entries(struct rte_cfgfile *cfg, * @param max_entries * Maximum number of section entries to be stored in entries array * @return -* Number of entries populated on success, negative error code otherwise +* Number of entries populated on success, -1 otherwise */ int rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, int index, @@ -190,7 +192,8 @@ int rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, struct rte_cfgfile_entry *entries, int max_entries); -/** Get value of the named entry in named config file section +/** +* Get value of the named entry in named config file section * * If multiple sections have the given name this function operates on the * first one. @@ -202,13 +205,14 @@ int rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, * @param entryname * Entry name * @return -* Entry value +* Entry value on success, NULL otherwise */ const char *rte_cfgfile_get_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname); -/** Check if given entry exists in named config file section +/** +* Check if given entry exists in named config file section * * If multiple sections have the given name this function operates on the * first one. @@ -225,12 +229,13 @@ const char *rte_cfgfile_get_entry(struct rte_cfgfile *cfg, int rte_cfgfile_has_entry(struct rte_cfgfile *cfg, const char *sectionname, const char *entryname); -/** Close config file +/** +* Close config file * * @param cfg * Config file * @return -* 0 on success, error code otherwise +* 0 on success, -1 otherwise */ int rte_cfgfile_close(struct rte_cfgfile *cfg); -- 1.9.1