mirror of
https://github.com/KhronosGroup/KTX-Software.git
synced 2026-01-18 17:41:19 +01:00
Minor documentation fixes (#890)
Some minor documentation fixes: - Wrong link, `isCubemap` should be `isCompressed`:7a45c4e615/include/ktx.h (L329)- Unnecessary `n` at7a45c4e615/include/ktx.h (L341)- Typo: "betweeb" should be "between" at7a45c4e615/lib/texture.c (L831)- Unnecessary `<` at7a45c4e615/tools/ktx/command_create.cpp (L765)- The link to pyktx is missing `../` in7a45c4e615/pkgdoc/toolsDoxyLayout.xml (L41)and related files (I.e. on https://github.khronos.org/KTX-Software/libktx/index.html , the link to pyktx is a 404), see https://github.com/search?q=repo%3AKhronosGroup%2FKTX-Software%20%22pyktx%20Reference%22&type=code
This commit is contained in:
@@ -326,7 +326,7 @@ typedef struct ktxTexture {
|
||||
* KTX_TRUE if the texture is a cubemap or cubemap array.
|
||||
*/
|
||||
/**
|
||||
* @typedef ktxTexture::isCubemap
|
||||
* @typedef ktxTexture::isCompressed
|
||||
* @~English
|
||||
*
|
||||
* KTX_TRUE if the texture's format is a block compressed format.
|
||||
@@ -338,7 +338,7 @@ typedef struct ktxTexture {
|
||||
* KTX_TRUE if mipmaps should be generated for the texture by
|
||||
* ktxTexture_GLUpload() or ktxTexture_VkUpload().
|
||||
*/
|
||||
/**n
|
||||
/**
|
||||
* @typedef ktxTexture::baseWidth
|
||||
* @~English
|
||||
* @brief Width of the texture's base level.
|
||||
|
||||
@@ -828,7 +828,7 @@ ktxTexture_rowInfo(ktxTexture* This, ktx_uint32_t level,
|
||||
/**
|
||||
* @memberof ktxTexture
|
||||
* @~English
|
||||
* @brief Return pitch betweeb rows of a texture image level in bytes.
|
||||
* @brief Return pitch between rows of a texture image level in bytes.
|
||||
*
|
||||
* For uncompressed textures the pitch is the number of bytes between
|
||||
* rows of texels. For compressed textures it is the number of bytes
|
||||
|
||||
@@ -37,7 +37,7 @@
|
||||
<tab type="user" url="../index.html" title="Package"/>
|
||||
<tab type="user" url="../ktxtools/index.html" title="KTX Tools Reference"/>
|
||||
<tab type="user" url="../libktx/index.html" title="libktx Reference"/>
|
||||
<tab type="user" url="pyktx/index.html" title="pyktx Reference"/>
|
||||
<tab type="user" url="../pyktx/index.html" title="pyktx Reference"/>
|
||||
<!-- navindex processing does not look in the .tag file so @ref is NG.
|
||||
URL to file is fragile.
|
||||
<tab type="user" url="@ref license" title="License"/> -->
|
||||
|
||||
@@ -39,7 +39,7 @@
|
||||
<tab type="user" url="../ktxtools/index.html" title="KTX Tools Reference"/>
|
||||
<tab type="user" url="../ktxjswrappers/index.html"
|
||||
title="KTX Javascript Wrappers Reference"/>
|
||||
<tab type="user" url="pyktx/index.html" title="pyktx Reference"/>
|
||||
<tab type="user" url="../pyktx/index.html" title="pyktx Reference"/>
|
||||
<!-- navindex processing does not look in the .tag file so @ref is NG.
|
||||
URL to file is fragile.
|
||||
<tab type="user" url="@ref license" title="License"/> -->
|
||||
|
||||
@@ -38,7 +38,7 @@
|
||||
<tab type="user" url="../libktx/index.html" title="libktx Reference"/>
|
||||
<tab type="user" url="../ktxjswrappers/index.html"
|
||||
title="KTX Javascript Wrappers Reference"/>
|
||||
<tab type="user" url="pyktx/index.html" title="pyktx Reference"/>
|
||||
<tab type="user" url="../pyktx/index.html" title="pyktx Reference"/>
|
||||
<!-- navindex processing does not look in the .tag file so @ref is NG.
|
||||
URL to file is fragile.
|
||||
<tab type="user" url="@ref license" title="License"/> -->
|
||||
|
||||
@@ -762,7 +762,7 @@ Create a KTX2 file from various input files.
|
||||
</dl>
|
||||
</dl>
|
||||
<dl>
|
||||
<dt>\--encode basis-lz | uastc<</dt>
|
||||
<dt>\--encode basis-lz | uastc</dt>
|
||||
<dd>Encode the texture with the specified codec before saving it.
|
||||
This option matches the functionality of the @ref ktx_encode "ktx encode" command.
|
||||
With each encoding option the following encoder specific options become valid,
|
||||
|
||||
Reference in New Issue
Block a user