shinys000114/libssh
1
0
Fork 0
mirror of https://git.libssh.org/projects/libssh.git synced 2026-02-04 12:20:42 +09:00
Code Issues Packages Projects Releases Wiki Activity

doc: Fix doxygen errors when QUIET=yes EXTRACT_ALL=yes

Browse Source 
Signed-off-by: Norbert Pocs <npocs@redhat.com>
Reviewed-by: Sahana Prasad <sahana@redhat.com>
Reviewed-by: Jakub Jelen <jjelen@redhat.com>
This commit is contained in:
Norbert Pocs
2023-03-14 11:08:30 +01:00
parent 45a8d1dbb1
commit 7b12876f04
7 changed files with 8 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/CMakeLists.txt
View File

@@ -18,7 +18,8 @@ if (DOXYGEN_FOUND)
set(DOXYGEN_PREDEFINED DOXYGEN set(DOXYGEN_PREDEFINED DOXYGEN
WITH_SERVER WITH_SERVER
WITH_SFTP WITH_SFTP
PRINTF_ATTRIBUTE(x,y)) PRINTF_ATTRIBUTE\(x,y\))
set(DOXYGEN_DOT_GRAPH_MAX_NODES 100)
set(DOXYGEN_EXCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/that_style) set(DOXYGEN_EXCLUDE ${CMAKE_CURRENT_SOURCE_DIR}/that_style)
set(DOXYGEN_HTML_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/that_style/header.html) set(DOXYGEN_HTML_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/that_style/header.html)

2
include/libssh/callbacks.h
View File

@@ -965,7 +965,7 @@ LIBSSH_API int ssh_remove_channel_callbacks(ssh_channel channel,
/** @} */ /** @} */
/** @group libssh_threads /** @addtogroup libssh_threads
* @{ * @{
*/ */

4
include/libssh/ed25519.h
View File

@@ -24,10 +24,10 @@
/** /**
* @defgroup ed25519 ed25519 API * @defgroup ed25519 ed25519 API
* @internal
* @brief API for DJB's ed25519 * @brief API for DJB's ed25519
* *
* @{ */ * @{
*/
#define ED25519_PK_LEN 32 #define ED25519_PK_LEN 32
#define ED25519_SK_LEN 64 #define ED25519_SK_LEN 64

2
include/libssh/misc.h
View File

@@ -79,7 +79,7 @@ const void *_ssh_list_pop_head(struct ssh_list *list);
/** @brief fetch the head element of a list and remove it from list /** @brief fetch the head element of a list and remove it from list
* @param type type of the element to return * @param type type of the element to return
* @param list the ssh_list to use * @param ssh_list the ssh_list to use
* @return the first element of the list, or NULL if the list is empty * @return the first element of the list, or NULL if the list is empty
*/ */
#define ssh_list_pop_head(type, ssh_list)\ #define ssh_list_pop_head(type, ssh_list)\

1
src/gssapi.c
View File

@@ -593,6 +593,7 @@ ssh_gssapi_creds ssh_gssapi_get_creds(ssh_session session)
* Unlike ssh_gssapi_get_creds() this is called on the client side of an ssh * Unlike ssh_gssapi_get_creds() this is called on the client side of an ssh
* connection. * connection.
* *
* @param[in] session The session
* @param[in] creds gssapi credentials handle. * @param[in] creds gssapi credentials handle.
*/ */
void ssh_gssapi_set_creds(ssh_session session, const ssh_gssapi_creds creds) void ssh_gssapi_set_creds(ssh_session session, const ssh_gssapi_creds creds)

9
src/pcap.c
View File

@@ -44,14 +44,11 @@
#include "libssh/socket.h" #include "libssh/socket.h"
/** /**
* @internal
*
* @defgroup libssh_pcap The libssh pcap functions * @defgroup libssh_pcap The libssh pcap functions
* @ingroup libssh * @ingroup libssh
* *
* The pcap file generation * The pcap file generation
* *
*
* @{ * @{
*/ */
@@ -98,7 +95,6 @@ struct pcaprec_hdr_s {
* in a SSH session only. Multiple pcap contexts may be used into * in a SSH session only. Multiple pcap contexts may be used into
* a single pcap file. * a single pcap file.
*/ */
struct ssh_pcap_context_struct { struct ssh_pcap_context_struct {
ssh_session session; ssh_session session;
ssh_pcap_file file; ssh_pcap_file file;
@@ -280,7 +276,6 @@ void ssh_pcap_file_free(ssh_pcap_file pcap){
/** @internal /** @internal
* @brief allocates a new ssh_pcap_context object * @brief allocates a new ssh_pcap_context object
*/ */
ssh_pcap_context ssh_pcap_context_new(ssh_session session){ ssh_pcap_context ssh_pcap_context_new(ssh_session session){
ssh_pcap_context ctx = (struct ssh_pcap_context_struct *) malloc(sizeof(struct ssh_pcap_context_struct)); ssh_pcap_context ctx = (struct ssh_pcap_context_struct *) malloc(sizeof(struct ssh_pcap_context_struct));
if(ctx==NULL){ if(ctx==NULL){
@@ -523,7 +518,7 @@ int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcap){
session->pcap_ctx=ctx; session->pcap_ctx=ctx;
return SSH_OK; return SSH_OK;
} }
/** @} */
#else /* WITH_PCAP */ #else /* WITH_PCAP */
@@ -557,5 +552,3 @@ int ssh_set_pcap_file(ssh_session session, ssh_pcap_file pcapfile){
} }
#endif #endif
/** @} */

2
src/socket.c
View File

@@ -65,8 +65,6 @@ struct sockaddr_un {
#include "libssh/session.h" #include "libssh/session.h"
/** /**
* @internal
*
* @defgroup libssh_socket The SSH socket functions. * @defgroup libssh_socket The SSH socket functions.
* @ingroup libssh * @ingroup libssh
* *