Skip to content

Commit

Permalink
Fonts|Resources|Client: Relocated API documentation to more appropria…
Browse files Browse the repository at this point in the history
…te places
  • Loading branch information
danij-deng committed Nov 15, 2013
1 parent 10c60ab commit 6cd880b
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 21 deletions.
6 changes: 6 additions & 0 deletions doomsday/client/include/resource/abstractfont.h
Expand Up @@ -34,6 +34,12 @@ class FontManifest;
/**
* Abstract font resource.
*
* @em Clearing a font means any names bound to it are deleted and any GL textures
* acquired for it are 'released' at this time). The Font instance record used
* to represent it is also deleted.
*
* @em Releasing a font will release any GL textures acquired for it.
*
* @ingroup resource
*/
class AbstractFont
Expand Down
14 changes: 1 addition & 13 deletions doomsday/client/include/resource/fonts.h
Expand Up @@ -38,19 +38,7 @@ namespace de {
/**
* Font resource collection.
*
* @em Runtime fonts are not loaded until precached or actually needed. They may
* be cleared, in which case they will be reloaded when needed.
*
* @em System fonts are loaded at startup and remain in memory all the time. After
* clearing they must be manually reloaded.
*
* "Clearing" a font means any names bound to it are deleted and any GL textures
* acquired for it are 'released' at this time). The Font instance record used
* to represent it is also deleted.
*
* "Releasing" a font will release any GL textures acquired for it.
*
* Thus there are two general states for a font:
* There are two general states for a font:
*
* A) Declared but not defined.
* B) Declared and defined.
Expand Down
10 changes: 9 additions & 1 deletion doomsday/client/include/resource/resourcesystem.h
Expand Up @@ -30,7 +30,15 @@
#include <de/System>

/**
* Logical resources; materials, packages, textures, etc... @ingroup resource
* Logical resources; materials, packages, textures, etc...
*
* @em Runtime fonts are not loaded until precached or actually needed. They
* may be cleared, in which case they will be reloaded when needed.
*
* @em System fonts are loaded at startup and remain in memory all the time.
* After clearing they must be manually reloaded.
*
* @ingroup resource
*/
class ResourceSystem : public de::System
{
Expand Down
7 changes: 1 addition & 6 deletions doomsday/client/src/resource/fonts.cpp
Expand Up @@ -207,7 +207,7 @@ Fonts::Manifest &Fonts::toManifest(fontid_t id) const
}

// Internal bookeeping error.
DENG_ASSERT(0);
DENG2_ASSERT(false);
}

/// @throw UnknownIdError The specified manifest id is invalid.
Expand Down Expand Up @@ -376,13 +376,8 @@ static int printIndex2(FontScheme *scheme, Path const &like,
// Print the result index key.
int numFoundDigits = de::max(3/*idx*/, M_NumDigits(found.count()));

#ifdef __CLIENT__
Con_Printf(" %*s: %-*s origin n# uri\n", numFoundDigits, "idx",
printSchemeName? 22 : 14, printSchemeName? "scheme:path" : "path");
#else
Con_Printf(" %*s: %-*s origin uri\n", numFoundDigits, "idx",
printSchemeName? 22 : 14, printSchemeName? "scheme:path" : "path");
#endif
Con_PrintRuler();

// Sort and print the index.
Expand Down
2 changes: 1 addition & 1 deletion doomsday/client/src/resource/resourcesystem.cpp
Expand Up @@ -109,7 +109,7 @@ DENG2_PIMPL(ResourceSystem)
textures.createScheme("Flaremaps");

#ifdef __CLIENT__
LOG_VERBOSE("Initializing Font collection...");
LOG_MSG("Initializing Font collection...");
/// @note Order here defines the ambigious-URI search order.
fonts.createScheme("System");
fonts.createScheme("Game");
Expand Down

0 comments on commit 6cd880b

Please sign in to comment.