Ticket #898 (closed task: fixed)

Opened 6 years ago

Last modified 5 years ago

[TRIVIAL] Move Doxygen annotations from .c files to the headers

Reported by: bricks Owned by:
Priority: normal Milestone: OpenSync 0.40
Component: OpenSync: API Documentation Version: 0.38
Severity: minor Keywords: doxygen, documentation
Cc:

Description

Doxygen annotations should be inside the Headers instead of the C Code. This Ticket is related to #755

Change History

comment:1 Changed 6 years ago by bricks

  • Status changed from new to assigned

comment:2 Changed 6 years ago by tuju

  • Version changed from 0.39 to 0.38

This must have been for 0.38 release as 0.39 is not released yet? :)

comment:3 Changed 6 years ago by chi70

see also r3751 Moved API description into header files. some are moved, not all.

From my understanding these are candidates to move stuff from: based on rev 3767

 find . -type f -name \*.c | xargs grep -l "@brief"
./opensync/mapping/opensync_mapping_table.c
./opensync/format/opensync_time.c
./opensync/format/opensync_format_env.c
./opensync/format/opensync_objformat.c
./opensync/format/opensync_objformat_sink.c
./opensync/format/opensync_filter.c
./opensync/format/opensync_converter.c
./opensync/opensync_support.c
./opensync/merger/opensync_capabilities.c
./opensync/merger/opensync_capability.c
./opensync/merger/opensync_merger.c
./opensync/opensync_xml.c
./opensync/db/opensync_db.c
./opensync/version/opensync_version.c
./opensync/plugin/opensync_plugin.c
./opensync/plugin/opensync_plugin_env.c
./opensync/plugin/opensync_plugin_info.c
./opensync/plugin/opensync_sink.c
./opensync/opensync_error.c
./opensync/group/opensync_member.c
./opensync/group/opensync_updater.c
./opensync/group/opensync_group.c
./opensync/group/opensync_group_env.c
./opensync/ipc/opensync_queue.c
./opensync/ipc/opensync_message.c
./opensync/module/opensync_module.c
./opensync/archive/opensync_archive.c
./opensync/xmlformat/opensync_xmlfieldlist.c
./opensync/xmlformat/opensync_xmlformat.c
./opensync/xmlformat/opensync_xmlfield.c
./opensync/xmlformat/opensync_xmlformat_schema.c
./opensync/helper/opensync_anchor.c
./opensync/helper/opensync_hashtable.c
./opensync/data/opensync_change.c
./opensync/data/opensync_data.c
./opensync/engine/opensync_engine.c
./opensync/engine/opensync_mapping_engine.c
./tests/support.c

comment:4 Changed 6 years ago by bricks

Finished archive, data and db

comment:5 Changed 6 years ago by bricks

Only some less important c files are left

grep -inr --include "*.c" "\/\*\!" opensync opensync/common/opensync_memory.c:53:/*! @brief Bit counting opensync/common/opensync_xml.c:503:/*! @brief Opens a xml document opensync/debug/opensync_trace.c:71:/*! @brief Initailize tracing opensync/format/opensync_time.c:69:/*! @brief Function remove dashes from datestamp and colon opensync/format/opensync_time.c:151:/*! @brief Function sets the time of vtime timestamp to the given time parameter opensync/format/opensync_time.c:551:/*! List of vcal fields which have should be converted by following opensync/format/opensync_time.c:564:/*! @brief Function converts a UTC vtime stamp to a localtime vtime stamp opensync/format/opensync_time.c:604:/*! @brief Functions converts timestamps of vcal in localtime or UTC.

comment:6 Changed 6 years ago by bricks

Latest update:

~/subversion/opensync$ find . -type f -name \*.c | xargs grep -l "@brief"
./tests/support.c
./opensync/client/opensync_client_proxy.c
./opensync/debug/opensync_trace.c
./opensync/ipc/opensync_queue.c
./opensync/format/opensync_time.c
./opensync/common/opensync_xml.c
./opensync/common/opensync_memory.c
./opensync/group/opensync_member.c

comment:7 Changed 5 years ago by dgollub

  • Owner bricks deleted
  • Status changed from assigned to new
  • Component changed from OpenSync to OpenSync: API Documentation
  • Summary changed from Move Doxygen annotations from .c files to the headers to [TRIVIAL] Move Doxygen annotations from .c files to the headers
./tests/support.c
./tests/group-tests/check_member.c
./opensync/common/opensync_xml.c
./opensync/ipc/opensync_queue.c
./opensync/client/opensync_client_proxy.c
./opensync/format/opensync_time.c
./opensync/debug/opensync_trace.c
./opensync/group/opensync_member.c

Maybe we should reassign the ticket to someone else? So Björn can concentrate on more complex coding issues?

comment:8 Changed 5 years ago by dgollub

(In [6000]) Move doxygen anotation to header file

refs #898

comment:9 Changed 5 years ago by dgollub

  • Status changed from new to closed
  • Resolution set to fixed

(In [6001]) Move all doxygen anotation from C-files to their header files. This is now complete for the opensync/ directory.

fixes #898

Note: See TracTickets for help on using tickets.