[libvirt] [PATCH] Remove redundant docs from libvirt.h

Only types and macros are documented in libvirt.h, APIs are documented in the *.c file they are implemented in. Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- include/libvirt/libvirt.h.in | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/include/libvirt/libvirt.h.in b/include/libvirt/libvirt.h.in index 7e695a3..3f7a201 100644 --- a/include/libvirt/libvirt.h.in +++ b/include/libvirt/libvirt.h.in @@ -4122,17 +4122,6 @@ typedef enum { #endif } virCPUCompareResult; -/** - * virConnectCompareCPU: - * - * @conn: virConnect connection - * @xmlDesc: XML description of either guest or host cpu with <cpu> root tag - * @flags: comparison flags - * - * Compares given CPU with host cpu. - * - * Returns virCPUCompareResult. - */ int virConnectCompareCPU(virConnectPtr conn, const char *xmlDesc, unsigned int flags); @@ -4151,19 +4140,6 @@ typedef enum { VIR_CONNECT_BASELINE_CPU_EXPAND_FEATURES = (1 << 0), /* show all features */ } virConnectBaselineCPUFlags; -/** - * virConnectBaselineCPU: - * - * @conn: virConnect connection - * @ncpus: number of CPUs in xmlCPUs - * @xmlCPUs: array of XML descriptions of host CPUs - * @flags: fine-tuning flags - * - * Computes the most feature-rich CPU which is compatible with all given - * host CPUs. - * - * Returns XML description of the computed CPU or NULL on error. - */ char *virConnectBaselineCPU(virConnectPtr conn, const char **xmlCPUs, unsigned int ncpus, -- 2.0.0

On 06/25/14 14:15, Jiri Denemark wrote:
Only types and macros are documented in libvirt.h, APIs are documented in the *.c file they are implemented in.
Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- include/libvirt/libvirt.h.in | 24 ------------------------ 1 file changed, 24 deletions(-)
ACK Peter

On Wed, Jun 25, 2014 at 14:19:19 +0200, Peter Krempa wrote:
On 06/25/14 14:15, Jiri Denemark wrote:
Only types and macros are documented in libvirt.h, APIs are documented in the *.c file they are implemented in.
Signed-off-by: Jiri Denemark <jdenemar@redhat.com> --- include/libvirt/libvirt.h.in | 24 ------------------------ 1 file changed, 24 deletions(-)
ACK
Pushed, thanks. Jirka
participants (2)
-
Jiri Denemark
-
Peter Krempa