bareos: master c0eadb5c

Diff Back to Repository
Author Committer Branch Timestamp Parent
pstorz pstorz master 2016-12-12 14:19 master 28c52709 Pending
Changeset doxygen: introduced doxygen to the project

We introduce the usage of doxygen for the code
documentation.

Therefore existing files were altered so that doxygen
understands the documenting comments:

1. Documentation of functions

Many functions already had a comment block in front of the function
like:
----------------------------------------------------------------
/*
 * This glues the NDMP File Handle DB with internal code.
 */
static inline void register_callback_hooks(struct ndmlog *ixlog)
----------------------------------------------------------------

This was altered so that doxygen understands that this is a documenting
comment, which means that the comments start with '/**' instead of '/*':

----------------------------------------------------------------
/**
 * This glues the NDMP File Handle DB with internal code.
 */
static inline void register_callback_hooks(struct ndmlog *ixlog)
----------------------------------------------------------------

2. Documentation of files

Almost all files already had a description of the file itself like:
----------------------------------------------------------------
/*
 * Backup specific NDMP Data Management Application (DMA) routines
 *
 * Marco van Wieringen, May 2015
 */
----------------------------------------------------------------

This was changed so that the describing part is recognized as file
description by doxygen by adding the @file keyword.
Existing copyright notes were kept in "normal" comment.

----------------------------------------------------------------
/*
 * Marco van Wieringen, May 2015
 */
/**
 * @file
 * Backup specific NDMP Data Management Application (DMA) routines
 */
----------------------------------------------------------------

3. Documentation of struct/class members

Structure and class member description already exists in a lot of
places like:

----------------------------------------------------------------
struct JOB_DBR {
   JobId_t JobId;
   char Job[MAX_NAME_LENGTH]; /* Job unique name */
   char Name[MAX_NAME_LENGTH]; /* Job base name */
----------------------------------------------------------------
As doxygen usually expects the documentation for a certain element
BEFORE the element itself, we need to do two things here:

* we change the /* to /** so that doxygen knows that this is documentation
* we need to add a < to the /** so that we have /**< which tells doxygen
  that this documents the element BEFORE the comment.

----------------------------------------------------------------
struct JOB_DBR {
   JobId_t JobId;
   char Job[MAX_NAME_LENGTH]; /**< Job unique name */
   char Name[MAX_NAME_LENGTH]; /**< Job base name */
----------------------------------------------------------------
add - doxygen/README Diff File
add - doxygen/bareos.doxy Diff File
add - doxygen/create_doxygen_documentation.sh Diff File
mod - src/cats/bvfs.c Diff File
mod - src/cats/bvfs.h Diff File
mod - src/cats/cats.c Diff File
mod - src/cats/cats_backends.c Diff File
mod - src/cats/cats_backends.h Diff File
mod - src/cats/dbi.c Diff File
mod - src/cats/ingres.c Diff File
mod - src/cats/myingres.c Diff File
mod - src/cats/mysql.c Diff File
mod - src/cats/postgresql.c Diff File
mod - src/cats/sql.c Diff File
mod - src/cats/sql_create.c Diff File
mod - src/cats/sql_delete.c Diff File
mod - src/cats/sql_find.c Diff File
mod - src/cats/sql_pooling.c Diff File
mod - src/cats/sql_update.c Diff File
mod - src/cats/sqlite.c Diff File
mod - src/console/conio.c Diff File
mod - src/console/console.c Diff File
mod - src/console/console_conf.c Diff File
mod - src/console/console_conf.h Diff File
mod - src/console/func.h Diff File
mod - src/dird/admin.c Diff File
mod - src/dird/archive.c Diff File
mod - src/dird/authenticate.c Diff File
mod - src/dird/autoprune.c Diff File
mod - src/dird/backup.c Diff File
mod - src/dird/bsr.c Diff File
mod - src/dird/bsr.h Diff File
mod - src/dird/catreq.c Diff File
mod - src/dird/consolidate.c Diff File
mod - src/dird/dbcheck.c Diff File
mod - src/dird/dir_plugins.c Diff File
mod - src/dird/dir_plugins.h Diff File
mod - src/dird/dird.c Diff File
mod - src/dird/dird.h Diff File
mod - src/dird/dird_conf.c Diff File
mod - src/dird/dird_conf.h Diff File
mod - src/dird/expand.c Diff File
mod - src/dird/fd_cmds.c Diff File
mod - src/dird/getmsg.c Diff File
mod - src/dird/inc_conf.c Diff File
mod - src/dird/inc_conf.h Diff File
mod - src/dird/job.c Diff File
mod - src/dird/jobq.c Diff File
mod - src/dird/jobq.h Diff File
mod - src/dird/migrate.c Diff File
mod - src/dird/mountreq.c Diff File
mod - src/dird/msgchan.c Diff File
mod - src/dird/ndmp_dma_backup.c Diff File
mod - src/dird/ndmp_dma_generic.c Diff File
mod - src/dird/ndmp_dma_priv.h Diff File
mod - src/dird/ndmp_dma_restore.c Diff File
mod - src/dird/ndmp_dma_storage.c Diff File
mod - src/dird/ndmp_fhdb_common.c Diff File
mod - src/dird/ndmp_fhdb_helpers.c Diff File
mod - src/dird/ndmp_fhdb_lmdb.c Diff File
mod - src/dird/ndmp_fhdb_mem.c Diff File
mod - src/dird/newvol.c Diff File
mod - src/dird/next_vol.c Diff File
mod - src/dird/protos.h Diff File
mod - src/dird/recycle.c Diff File
mod - src/dird/restore.c Diff File
mod - src/dird/run_conf.c Diff File
mod - src/dird/scheduler.c Diff File
mod - src/dird/sd_cmds.c Diff File
mod - src/dird/socket_server.c Diff File
mod - src/dird/stats.c Diff File
mod - src/dird/storage.c Diff File
mod - src/dird/testfind.c Diff File
mod - src/dird/ua.h Diff File
mod - src/dird/ua_acl.c Diff File
mod - src/dird/ua_audit.c Diff File
mod - src/dird/ua_cmds.c Diff File
mod - src/dird/ua_configure.c Diff File
mod - src/dird/ua_db.c Diff File
mod - src/dird/ua_dotcmds.c Diff File
mod - src/dird/ua_impexp.c Diff File
mod - src/dird/ua_input.c Diff File
mod - src/dird/ua_label.c Diff File
mod - src/dird/ua_output.c Diff File
mod - src/dird/ua_prune.c Diff File
mod - src/dird/ua_purge.c Diff File
mod - src/dird/ua_query.c Diff File
mod - src/dird/ua_restore.c Diff File
mod - src/dird/ua_run.c Diff File
mod - src/dird/ua_select.c Diff File
mod - src/dird/ua_server.c Diff File
mod - src/dird/ua_status.c Diff File
mod - src/dird/ua_tree.c Diff File
mod - src/dird/ua_update.c Diff File
mod - src/dird/vbackup.c Diff File
mod - src/dird/verify.c Diff File
mod - src/filed/accurate.c Diff File
mod - src/filed/accurate_htable.c Diff File
mod - src/filed/accurate_lmdb.c Diff File
mod - src/filed/authenticate.c Diff File
mod - src/filed/backup.c Diff File
mod - src/filed/compression.c Diff File
mod - src/filed/crypto.c Diff File
mod - src/filed/dir_cmd.c Diff File
mod - src/filed/estimate.c Diff File
mod - src/filed/fd_plugins.c Diff File
mod - src/filed/filed.c Diff File
mod - src/filed/filed_conf.c Diff File
mod - src/filed/fileset.c Diff File
mod - src/filed/heartbeat.c Diff File
mod - src/filed/restore.c Diff File
mod - src/filed/sd_cmds.c Diff File
mod - src/filed/socket_server.c Diff File
mod - src/filed/status.c Diff File
mod - src/filed/verify.c Diff File
mod - src/filed/verify_vol.c Diff File
mod - src/findlib/acl.c Diff File
mod - src/findlib/acl.h Diff File
mod - src/findlib/attribs.c Diff File
mod - src/findlib/bfile.c Diff File
mod - src/findlib/bfile.h Diff File
mod - src/findlib/create_file.c Diff File
mod - src/findlib/drivetype.c Diff File
mod - src/findlib/enable_priv.c Diff File
mod - src/findlib/find.c Diff File
mod - src/findlib/find.h Diff File
mod - src/findlib/find_one.c Diff File
mod - src/findlib/fstype.c Diff File
mod - src/findlib/hardlink.c Diff File
mod - src/findlib/match.c Diff File
mod - src/findlib/mkpath.c Diff File
mod - src/findlib/protos.h Diff File
mod - src/findlib/savecwd.c Diff File
mod - src/findlib/savecwd.h Diff File
mod - src/findlib/shadowing.c Diff File
mod - src/findlib/xattr.c Diff File
mod - src/findlib/xattr.h Diff File
mod - src/include/baconfig.h Diff File
mod - src/include/bareos.h Diff File
mod - src/include/bc_types.h Diff File
mod - src/include/ch.h Diff File
mod - src/include/fileopts.h Diff File
mod - src/include/filetypes.h Diff File
mod - src/include/hostconfig.h Diff File
mod - src/include/jcr.h Diff File
mod - src/include/streams.h Diff File
mod - src/lib/address_conf.c Diff File
mod - src/lib/address_conf.h Diff File
mod - src/lib/alist.c Diff File
mod - src/lib/alist.h Diff File
mod - src/lib/attr.c Diff File
mod - src/lib/attr.h Diff File
mod - src/lib/attribs.c Diff File
mod - src/lib/base64.c Diff File
mod - src/lib/base64.h Diff File
mod - src/lib/berrno.c Diff File
mod - src/lib/berrno.h Diff File
mod - src/lib/bget_msg.c Diff File
mod - src/lib/binflate.c Diff File
mod - src/lib/bits.h Diff File
mod - src/lib/bmtio.h Diff File
mod - src/lib/bnet.c Diff File
mod - src/lib/bnet_server_tcp.c Diff File
mod - src/lib/bpipe.h Diff File
mod - src/lib/breg.h Diff File
mod - src/lib/bregex.h Diff File
mod - src/lib/bsock.h Diff File
mod - src/lib/bsr.h Diff File
mod - src/lib/btimers.h Diff File
mod - src/lib/cbuf.h Diff File
mod - src/lib/compression.c Diff File
mod - src/lib/connection_pool.h Diff File
mod - src/lib/crypto.h Diff File
mod - src/lib/crypto_cache.h Diff File
mod - src/lib/devlock.h Diff File
mod - src/lib/dlist.h Diff File
mod - src/lib/guid_to_name.h Diff File
mod - src/lib/htable.h Diff File
mod - src/lib/lex.h Diff File
mod - src/lib/mem_pool.h Diff File
mod - src/lib/message.h Diff File
mod - src/lib/output_formatter.h Diff File
mod - src/lib/plugins.h Diff File
mod - src/lib/protos.h Diff File
mod - src/lib/queue.h Diff File
mod - src/lib/rblist.h Diff File
mod - src/lib/runscript.h Diff File
mod - src/lib/rwlock.h Diff File
mod - src/lib/sellist.h Diff File
mod - src/lib/serial.h Diff File
mod - src/lib/smartall.h Diff File
mod - src/lib/status.h Diff File
mod - src/lib/tree.h Diff File
mod - src/lib/var.h Diff File
mod - src/lib/waitq.h Diff File
mod - src/lib/watchdog.h Diff File
mod - src/lib/workq.h Diff File
mod - src/plugins/dird/example-plugin-dir.c Diff File
mod - src/plugins/dird/python-dir.c Diff File
mod - src/plugins/dird/python-dir.h Diff File
mod - src/plugins/filed/bpipe-fd.c Diff File
mod - src/plugins/filed/cephfs-fd.c Diff File
mod - src/plugins/filed/fd_common.h Diff File
mod - src/plugins/filed/gfapi-fd.c Diff File
mod - src/plugins/filed/python-fd.c Diff File
mod - src/plugins/filed/python-fd.h Diff File
mod - src/plugins/filed/rados-fd.c Diff File
mod - src/plugins/filed/test-deltaseq-fd.c Diff File
mod - src/plugins/filed/test-plugin-fd.c Diff File
mod - src/plugins/stored/autoxflate-sd.c Diff File
mod - src/plugins/stored/example-plugin-sd.c Diff File
mod - src/plugins/stored/python-sd.c Diff File
mod - src/plugins/stored/python-sd.h Diff File
mod - src/plugins/stored/scsicrypto-sd.c Diff File
mod - src/plugins/stored/scsitapealert-sd.c Diff File
mod - src/stored/acquire.c Diff File
mod - src/stored/ansi_label.c Diff File
mod - src/stored/append.c Diff File
mod - src/stored/askdir.c Diff File
mod - src/stored/authenticate.c Diff File
mod - src/stored/autochanger.c Diff File
mod - src/stored/backends/cephfs_device.c Diff File
mod - src/stored/backends/elasto_device.c Diff File
mod - src/stored/backends/generic_tape_device.c Diff File
mod - src/stored/backends/gfapi_device.c Diff File
mod - src/stored/backends/object_store_device.c Diff File
mod - src/stored/backends/rados_device.c Diff File
mod - src/stored/backends/unix_fifo_device.c Diff File
mod - src/stored/backends/unix_file_device.c Diff File
mod - src/stored/backends/unix_tape_device.c Diff File
mod - src/stored/bcopy.c Diff File
mod - src/stored/bextract.c Diff File
mod - src/stored/block.c Diff File
mod - src/stored/block.h Diff File
mod - src/stored/bls.c Diff File
mod - src/stored/bscan.c Diff File
mod - src/stored/bsr.c Diff File
mod - src/stored/btape.c Diff File
mod - src/stored/butil.c Diff File
mod - src/stored/crc32.c Diff File
mod - src/stored/dev.c Diff File
mod - src/stored/dev.h Diff File
mod - src/stored/device.c Diff File
mod - src/stored/dir_cmd.c Diff File
mod - src/stored/ebcdic.c Diff File
mod - src/stored/fd_cmds.c Diff File
mod - src/stored/job.c Diff File
mod - src/stored/label.c Diff File
mod - src/stored/lock.c Diff File
mod - src/stored/lock.h Diff File
mod - src/stored/mac.c Diff File
mod - src/stored/mount.c Diff File
mod - src/stored/ndmp_tape.c Diff File
mod - src/stored/protos.h Diff File
mod - src/stored/read.c Diff File
mod - src/stored/read_record.c Diff File
mod - src/stored/record.c Diff File
mod - src/stored/record.h Diff File
mod - src/stored/reserve.c Diff File
mod - src/stored/reserve.h Diff File
mod - src/stored/scan.c Diff File
mod - src/stored/sd_backends.c Diff File
mod - src/stored/sd_backends.h Diff File
mod - src/stored/sd_cmds.c Diff File
mod - src/stored/sd_plugins.c Diff File
mod - src/stored/sd_plugins.h Diff File
mod - src/stored/sd_stats.c Diff File
mod - src/stored/socket_server.c Diff File
mod - src/stored/spool.c Diff File
mod - src/stored/status.c Diff File
mod - src/stored/stored.c Diff File
mod - src/stored/stored.h Diff File
mod - src/stored/stored_conf.c Diff File
mod - src/stored/stored_conf.h Diff File
mod - src/stored/vol_mgr.c Diff File
mod - src/stored/vol_mgr.h Diff File
mod - src/stored/wait.c Diff File
mod - src/tools/bpluginfo.c Diff File
mod - src/tools/bregex.c Diff File
mod - src/tools/bscrypto.c Diff File
mod - src/tools/bwild.c Diff File
mod - src/tools/drivetype.c Diff File
mod - src/tools/fstype.c Diff File
mod - src/win32/compat/compat.c Diff File
mod - src/win32/compat/winapi.c Diff File
mod - src/win32/filed/vss.c Diff File
mod - src/win32/findlib/win32.c Diff File
mod - src/win32/generic/main.c Diff File
mod - src/win32/plugins/filed/mssqlvdi-fd.c Diff File
mod - src/win32/stored/backends/win32_fifo_device.c Diff File
mod - src/win32/stored/backends/win32_file_device.c Diff File
mod - src/win32/stored/backends/win32_tape_device.c Diff File