Commit 8d032900 authored by Holger Kaelberer's avatar Holger Kaelberer Committed by Bruno Coudoin
Browse files

core, silence some doxygen warnings

parent a38c5126
......@@ -46,7 +46,6 @@ Among the more important classes are the following:
of GCompris.
</li>
</ul>
@endgroup
*/
/**
......@@ -74,5 +73,4 @@ Cf. Template.qml for a skeleton that can also be used as a starting point for
developing new activities.
Last but not least have a look at the existing activities to learn by example.
@endgroup
*/
......@@ -347,8 +347,6 @@ signals:
*
* Convenience signal and special case of resourceRegistered.
*
* @param resource Relative resource path of the registered resource.
*
* @sa resourceRegistered
*/
void voicesRegistered();
......
......@@ -87,7 +87,7 @@ Item {
/**
* Helper to normalize audio filename extensions.
*
* @param file Audio source url.
* @param type:string file Audio source url.
* @returns Url to the passed file with the extension adjusted to what is
* set in ApplicationInfo.CompressedAudio
* @sa ApplicationInfo.CompressedAudio
......@@ -102,7 +102,7 @@ Item {
/**
* Plays back the audio resource @p file.
*
* @param file [optional] URL to an audio source.
* @param type:string file [optional] URL to an audio source.
* @returns @c true if playback has been started, @c false if file does not
* exist or audio is muted
*/
......@@ -136,7 +136,7 @@ Item {
* played back immediately. Otherwise it is appended to the file queue of
* sources.
*
* @param url to the audio file to be played back.
* @param type:string file File to the audio file to be played back.
* @returns @c true upon success, or @c false if @p file does not exist or
* audio is muted
*/
......@@ -162,7 +162,7 @@ Item {
/**
* Adds a pause of the given duration in ms before playing of the next file.
*
* @param duration_ms Pause in milliseconds.
* @param type:int duration_ms Pause in milliseconds.
*/
function silence(duration_ms) {
silenceTimer.interval = duration_ms
......
......@@ -54,14 +54,14 @@ Item {
/**
* Parse the passed json string and return a corresponding object.
*
* @param json JSON string to parse.
* @param validateFunc Function used to semantically validate the parsed
* json [optional].
* The function must have the signature
* <tt>bool validateFunc(jsonString)</tt>
* and return @c true if json string is semantically
* valid, @c false otherwise.
* @returns The object parsed from json if valid, @cnull if json is
* @param type:string json JSON string to parse.
* @param type:function validateFunc Function used to semantically validate
* the parsed json [optional].
* The function must have the signature
* <tt>bool validateFunc(jsonString)</tt>
* and return @c true if json string is semantically
* valid, @c false otherwise.
* @returns The object parsed from json if valid, @c null if json is
* syntactically or semantically invalid.
*/
function parseString(json, validateFunc)
......@@ -86,10 +86,10 @@ Item {
* Parse a json string from the given url and return a corresponding
* object.
*
* @param url Source URL for the json file to parse. Supported URL-schemes:
* file://, qrc://.
* @param validateFunc cf. @ref parseString
* @returns cf. @ref parseString
* @param type:string url Source URL for the json file to parse.
* Supported URL-schemes: file://, qrc://.
* @param type:functions validateFunc cf. @ref parseString
* @returns cf. @ref parseString
*/
function parseFromUrl(url, validateFunc)
{
......
......@@ -37,9 +37,14 @@ import GCompris 1.0
ParticleSystem {
id: particles
anchors.fill: parent
/// @cond INTERNAL_DOCS
property alias emitter: clickedEmitter
property alias clip: imageParticle.clip
/// @endcond
Emitter {
id: clickedEmitter
anchors.fill: parent
......
......@@ -35,6 +35,12 @@ import GCompris 1.0
Loader {
anchors.fill: parent
active: ApplicationInfo.hasShader
/**
* Emits count particles from the particle emitter immediately.
*
* Cf. Emitter.burst
*/
function burst(val) {
if(active)
item.emitter.burst(val)
......
......@@ -84,13 +84,16 @@ Item {
*/
property var wordList: ({})
// private?
/// @cond INTERNAL_DOCS
property var randomWordList: []
property int maxLevel: 0
/// @endcond
/**
* Emitted if an error occurs.
* @param type:string msg Error message.
* @param msg Error message.
*/
signal error(string msg);
......@@ -128,23 +131,6 @@ Item {
return wordList;
}
/* FIXME: this should be private! possible? */
function validateWordlist(doc)
{
// minimal syntax check:
var i;
if (undefined === doc.levels)
return false;
for (i = 0; i < doc.levels.length; i++) {
// check mandatory level properties only (speed, fallspeed and sublevels are optional)
if (doc.levels[i].words.length < 1)
return false;
}
if (i < 1)
return false;
return true;
}
/**
* Get wordlist data for @p level
*
......@@ -204,6 +190,26 @@ Item {
return randomWordList.pop()
}
/// @cond INTERNAL_DOCS
function validateWordlist(doc)
{
// minimal syntax check:
var i;
if (undefined === doc.levels)
return false;
for (i = 0; i < doc.levels.length; i++) {
// check mandatory level properties only (speed, fallspeed and sublevels are optional)
if (doc.levels[i].words.length < 1)
return false;
}
if (i < 1)
return false;
return true;
}
/// @endcond
JsonParser {
id: parser
......
......@@ -49,6 +49,8 @@ Window {
minimumHeight: 400
title: "GCompris"
/// @cond INTERNAL_DOCS
property var applicationState: Qt.application.state
onApplicationStateChanged: {
......@@ -263,4 +265,6 @@ Window {
property Component replaceTransition: pushHTransition
}
}
/// @endcond
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment