Commit cb1a3674 authored Jul 01, 2018 by Nick Mathewson

File-level documentation for some of src/lib.

parent 83a4946e

src/lib/arch/bytes.h

+7 −0

Original line number	Diff line number	Diff line
		@@ -6,6 +6,13 @@
		#ifndef TOR_BYTES_H
		#define TOR_BYTES_H

		/**
		* \file bytes.h
		*
		* \brief Inline functions for reading and writing multibyte values from
		* the middle of strings, and for manipulating byte order.
		**/

		#include <string.h>
		#include "lib/cc/torint.h"

src/lib/cc/torint.h

+6 −1

Original line number	Diff line number	Diff line
		@@ -11,6 +11,12 @@
		#ifndef TOR_TORINT_H
		#define TOR_TORINT_H

		/**
		* \file torint.h
		*
		* \brief Integer definitions used throughout Tor.
		**/

		#include "orconfig.h"

		#ifdef HAVE_STDINT_H
		@@ -376,4 +382,3 @@ typedef uint32_t uintptr_t;
		#define SIZE_T_CEILING ((size_t)(SSIZE_MAX-16))

		#endif /* !defined(TOR_TORINT_H) */

src/lib/compress/compress.c

+4 −1

Original line number	Diff line number	Diff line
		@@ -5,7 +5,10 @@

		/**
		* \file compress.c
		* \brief Common compression API.
		* \brief Common compression API implementation.
		*
		* This file provides a unified interface to all the compression libraries Tor
		* knows how to use.
		**/

		#include "orconfig.h"

src/lib/compress/compress_buf.c

+6 −0

Original line number	Diff line number	Diff line
		@@ -3,6 +3,12 @@
		* Copyright (c) 2007-2018, The Tor Project, Inc. */
		/* See LICENSE for licensing information */

		/**
		* \file compress_buf.c
		*
		* \brief Working with compressed data in buffers.
		**/

		#define BUFFERS_PRIVATE
		#include "lib/cc/compat_compiler.h"
		#include "lib/container/buffers.h"

src/lib/container/bitarray.h

+6 −0

Original line number	Diff line number	Diff line
		@@ -6,6 +6,12 @@
		#ifndef TOR_BITARRAY_H
		#define TOR_BITARRAY_H

		/**
		* \file bitarray.h
		*
		* \brief Implements a variable-sized (but non-resizeable) bit-array.
		**/

		#include "orconfig.h"
		#include <string.h>
		#include "lib/cc/torint.h"