mirror of
https://github.com/panda3d/panda3d.git
synced 2025-09-26 22:53:16 -04:00
general: Assorted API reference fixes
This commit is contained in:
parent
4d20b36098
commit
3daf1ae1b1
@ -12,7 +12,7 @@
|
||||
*/
|
||||
|
||||
/**
|
||||
* Returns true if the implicit *.prc files have already been loaded, false
|
||||
* Returns true if the implicit `*.prc` files have already been loaded, false
|
||||
* otherwise. Normally this will only be false briefly before startup.
|
||||
*/
|
||||
INLINE bool ConfigPageManager::
|
||||
@ -21,7 +21,7 @@ loaded_implicit_pages() const {
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches the PRC_DIR and/or PRC_PATH directories for *.prc files and loads
|
||||
* Searches the PRC_DIR and/or PRC_PATH directories for `*.prc` files and loads
|
||||
* them in as pages. This is normally called automatically at startup time,
|
||||
* when the first variable's value is referenced. See also
|
||||
* reload_implicit_pages().
|
||||
@ -46,9 +46,9 @@ get_search_path() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of patterns, like "*.prc", that are compiled in that
|
||||
* Returns the number of patterns, like `*.prc`, that are compiled in that
|
||||
* will be searched for as default config filenames. Normally there is only
|
||||
* one pattern, and it is "*.prc", but others may be specified with the
|
||||
* one pattern, and it is `*.prc`, but others may be specified with the
|
||||
* PRC_FILENAME variable in Config.pp.
|
||||
*/
|
||||
INLINE size_t ConfigPageManager::
|
||||
@ -67,7 +67,7 @@ get_prc_pattern(size_t n) const {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of patterns, like "*.pre", that are compiled in that
|
||||
* Returns the number of patterns, like `*.pre`, that are compiled in that
|
||||
* will be searched for as special config files that are understood to be
|
||||
* encrypted.
|
||||
*/
|
||||
@ -87,7 +87,7 @@ get_prc_encrypted_pattern(size_t n) const {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of patterns, like "*.exe", that are compiled in that
|
||||
* Returns the number of patterns, like `*.exe`, that are compiled in that
|
||||
* will be searched for as special config files that are to be executed as a
|
||||
* program, and their output taken to be input. This is normally empty.
|
||||
*/
|
||||
|
@ -82,7 +82,7 @@ make_variable(const string &name) {
|
||||
* Defines a variable "template" to match against dynamically-defined
|
||||
* variables that may or may not be created in the future.
|
||||
*
|
||||
* The template consists of a glob pattern, e.g. "notify-level-*", which will
|
||||
* The template consists of a glob pattern, e.g. `notify-level-*`, which will
|
||||
* be tested against any config variable passed to a future call to
|
||||
* make_variable(). If the pattern matches, the returned ConfigVariableCore
|
||||
* is copied to define the new variable, instead of creating a default, empty
|
||||
@ -92,7 +92,7 @@ make_variable(const string &name) {
|
||||
* all have similar properties, and all may not be created at the same time.
|
||||
* It is especially useful to avoid cluttering up the list of available
|
||||
* variables with user-declared variables that have not been defined yet by
|
||||
* the application (e.g. "egg-object-type-*").
|
||||
* the application (e.g. `egg-object-type-*`).
|
||||
*
|
||||
* This method basically pre-defines all variables that match the specified
|
||||
* glob pattern.
|
||||
|
@ -106,13 +106,11 @@ PUBLISHED:
|
||||
virtual void set_volume(PN_stdfloat volume) = 0;
|
||||
virtual PN_stdfloat get_volume() const = 0;
|
||||
|
||||
/*
|
||||
* Turn the manager on or off. If you play a sound while the manager is
|
||||
* inactive, it won't start. If you deactivate the manager while sounds are
|
||||
* playing, they'll stop. If you activate the manager while looping sounds
|
||||
* are playing (those that have a loop_count of zero), they will start playing
|
||||
* from the beginning of their loop. inits to true.
|
||||
*/
|
||||
// Turn the manager on or off. If you play a sound while the manager is
|
||||
// inactive, it won't start. If you deactivate the manager while sounds are
|
||||
// playing, they'll stop. If you activate the manager while looping sounds
|
||||
// are playing (those that have a loop_count of zero), they will start
|
||||
// playing from the beginning of their loop. Defaults to true.
|
||||
virtual void set_active(bool flag) = 0;
|
||||
virtual bool get_active() const = 0;
|
||||
|
||||
|
@ -71,8 +71,8 @@ get_3d_max_distance() const {
|
||||
*/
|
||||
PN_stdfloat AudioSound::
|
||||
get_speaker_mix(int speaker) {
|
||||
// intentionally blank
|
||||
return 0.0;
|
||||
// intentionally blank
|
||||
return 0.0;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -80,7 +80,7 @@ get_speaker_mix(int speaker) {
|
||||
*/
|
||||
void AudioSound::
|
||||
set_speaker_mix(PN_stdfloat frontleft, PN_stdfloat frontright, PN_stdfloat center, PN_stdfloat sub, PN_stdfloat backleft, PN_stdfloat backright, PN_stdfloat sideleft, PN_stdfloat sideright) {
|
||||
// intentionally blank
|
||||
// intentionally blank
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -110,8 +110,8 @@ PUBLISHED:
|
||||
virtual void set_3d_max_distance(PN_stdfloat dist);
|
||||
virtual PN_stdfloat get_3d_max_distance() const;
|
||||
|
||||
// *_speaker_mix and *_speaker_level(s) serve the same purpose.
|
||||
// *_speaker_mix is for use with FMOD. *_speaker_level(s) is for use with
|
||||
// speaker_mix and speaker_level(s) serve the same purpose.
|
||||
// speaker_mix is for use with FMOD. speaker_level(s) is for use with
|
||||
// Miles. Both interfaces exist because of a significant difference in the
|
||||
// two APIs. Hopefully the difference can be reconciled into a single
|
||||
// interface at some point.
|
||||
|
@ -663,7 +663,7 @@ get_proxies_for_url(const URLSpec &url) const {
|
||||
* Specifies the username:password string corresponding to a particular server
|
||||
* and/or realm, when demanded by the server. Either or both of the server or
|
||||
* realm may be empty; if so, they match anything. Also, the server may be
|
||||
* set to the special string "*proxy", which will match any proxy server.
|
||||
* set to the special string `"*proxy"`, which will match any proxy server.
|
||||
*
|
||||
* If the username is set to the empty string, this clears the password for
|
||||
* the particular server/realm pair.
|
||||
|
@ -1349,7 +1349,7 @@ invert_in_place() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Computes (*this) += other * weight.
|
||||
* Computes `(*this) += other * weight`.
|
||||
*/
|
||||
INLINE_LINMATH void FLOATNAME(LMatrix4)::
|
||||
accumulate(const FLOATNAME(LMatrix4) &other, FLOATTYPE weight) {
|
||||
|
Loading…
x
Reference in New Issue
Block a user