revi-archive/xz-archive
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
Code Activity

liblzma: Highlight liblzma API headers should not be included directly.

Browse source 
This improves the generated Doxygen HTML files to better highlight
how to properly use the liblzma API header files.
This commit is contained in:
Jia Tan 2022-12-21 23:59:43 +08:00
parent b43ff180fb
commit 6fcf4671b6
14 changed files with 42 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/liblzma/api/lzma/base.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/base.h * \file lzma/base.h
* \brief Data types and functions used in many places in liblzma API * \brief Data types and functions used in many places in liblzma API
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/bcj.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/bcj.h * \file lzma/bcj.h
* \brief Branch/Call/Jump conversion filters * \brief Branch/Call/Jump conversion filters
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/block.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/block.h * \file lzma/block.h
* \brief .xz Block handling * \brief .xz Block handling
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/check.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/check.h * \file lzma/check.h
* \brief Integrity checks * \brief Integrity checks
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/container.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/container.h * \file lzma/container.h
* \brief File formats * \brief File formats
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/delta.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/delta.h * \file lzma/delta.h
* \brief Delta filter * \brief Delta filter
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/filter.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/filter.h * \file lzma/filter.h
* \brief Common filter related types and functions * \brief Common filter related types and functions
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/hardware.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/hardware.h * \file lzma/hardware.h
* \brief Hardware information * \brief Hardware information
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
* *
* Since liblzma can consume a lot of system resources, it also provides * Since liblzma can consume a lot of system resources, it also provides
* ways to limit the resource usage. Applications linking against liblzma * ways to limit the resource usage. Applications linking against liblzma
@ -25,8 +28,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/index.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/index.h * \file lzma/index.h
* \brief Handling of .xz Index and related information * \brief Handling of .xz Index and related information
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/index_hash.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/index_hash.h * \file lzma/index_hash.h
* \brief Validate Index by using a hash function * \brief Validate Index by using a hash function
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
* *
* Hashing makes it possible to use constant amount of memory to validate * Hashing makes it possible to use constant amount of memory to validate
* Index of arbitrary size. * Index of arbitrary size.
@ -11,8 +14,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/lzma12.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/lzma12.h * \file lzma/lzma12.h
* \brief LZMA1 and LZMA2 filters * \brief LZMA1 and LZMA2 filters
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/stream_flags.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/stream_flags.h * \file lzma/stream_flags.h
* \brief .xz Stream Header and Stream Footer encoder and decoder * \brief .xz Stream Header and Stream Footer encoder and decoder
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/version.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/version.h * \file lzma/version.h
* \brief Version number * \brief Version number
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
/* /*
@ -8,8 +11,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL

5
src/liblzma/api/lzma/vli.h
View file

@ -1,6 +1,9 @@
/** /**
* \file lzma/vli.h * \file lzma/vli.h
* \brief Variable-length integer handling * \brief Variable-length integer handling
* \note Never include this file directly. Use <lzma.h> instead.
*
* See ../lzma.h for information about liblzma as a whole.
* *
* In the .xz format, most integers are encoded in a variable-length * In the .xz format, most integers are encoded in a variable-length
* representation, which is sometimes called little endian base-128 encoding. * representation, which is sometimes called little endian base-128 encoding.
@ -19,8 +22,6 @@
* *
* This file has been put into the public domain. * This file has been put into the public domain.
* You can do whatever you want with this file. * You can do whatever you want with this file.
*
* See ../lzma.h for information about liblzma as a whole.
*/ */
#ifndef LZMA_H_INTERNAL #ifndef LZMA_H_INTERNAL