aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJake Petroules <jake.petroules@qt.io>2017-08-28 22:40:04 -0700
committerJake Petroules <jake.petroules@qt.io>2017-08-30 07:06:40 +0000
commit0e2ae4b676e9a26ca42275088f55dc0917902bfb (patch)
tree0d42ffaeec5e484b0d31b2536f012eec09d94ed0
parent704066d0d9eb4ce33082fb52b158382277897852 (diff)
Document the relevant file tags of the ib module
Task-number: QBS-934 Change-Id: Iab702d0f450bf4335030f5f927cbf4b92cc61652 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
-rw-r--r--doc/external-resources.qdoc5
-rw-r--r--doc/reference/modules/ib-module.qdoc49
2 files changed, 54 insertions, 0 deletions
diff --git a/doc/external-resources.qdoc b/doc/external-resources.qdoc
index 2e8ab0cbf..b335fb4a8 100644
--- a/doc/external-resources.qdoc
+++ b/doc/external-resources.qdoc
@@ -26,6 +26,11 @@
****************************************************************************/
/*!
+ \externalpage https://developer.apple.com/library/content/documentation/GraphicsAnimation/Conceptual/HighResolutionOSX/Optimizing/Optimizing.html#//apple_ref/doc/uid/TP40012302-CH7-SW28
+ \title Adopt the @2x Naming Convention
+*/
+
+/*!
\externalpage https://login.qt.io/
\title Qt Account
*/
diff --git a/doc/reference/modules/ib-module.qdoc b/doc/reference/modules/ib-module.qdoc
index 656146877..f3d958da1 100644
--- a/doc/reference/modules/ib-module.qdoc
+++ b/doc/reference/modules/ib-module.qdoc
@@ -195,4 +195,53 @@
\li Directory where the iconutil binary is located.
This should not normally need to be changed.
\endtable
+
+ \section1 Relevant File Tags
+
+ \table
+ \header
+ \li Tag
+ \li Auto-tagged File Names
+ \li Since
+ \li Description
+ \row
+ \li \c{"assetcatalog"}
+ \li \c{*.xcassets}
+ \li 1.3
+ \li This tag is attached to directories that will be compiled into compiled asset catalog
+ archives (.car files) on supported platforms, or a collection of loose resource files.
+ The resulting files will be automatically tagged \c{bundle.input}. If the current
+ product is a bundle, the files will be included in the bundle's resources directory.
+ \row
+ \li \c{"iconset"}
+ \li \c{*.iconset}
+ \li 1.3
+ \li This tag is attached to directories that will be compiled into Apple ICNS files.
+ The resulting files will be automatically tagged \c{bundle.input}. If the current
+ product is a bundle, the files will be included in the bundle's resources directory.
+ \row
+ \li \c{"nib"}
+ \li \c{*.nib}, \c{*.xib}
+ \li 1.1
+ \li This tag is attached to "NIB" and "XIB" files that will be compiled.
+ The output may be a flat file or a bundle (directory structure).
+ The resulting files will be automatically tagged \c{bundle.input}. If the current
+ product is a bundle, the files will be included in the bundle's resources directory.
+ \row
+ \li \c{"png"}
+ \li \c{*.png}
+ \li 1.9
+ \li This tag is attached to PNG files that may be converted into multi-resolution TIFFs.
+ Source files should adopt the \l{Adopt the @2x Naming Convention}{@2x naming convention}
+ in order to be properly grouped.
+ The resulting files will be given the \c{tiff} file tag.
+ \row
+ \li \c{"storyboard"}
+ \li \c{*.storyboard}
+ \li 1.3
+ \li This tag is attached to storyboard files that will be compiled.
+ The output may be a flat file or a bundle (directory structure).
+ The resulting files will be automatically tagged \c{bundle.input}. If the current
+ product is a bundle, the files will be included in the bundle's resources directory.
+ \endtable
*/