1
0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00

docs(todo): Changed todo format

This commit is contained in:
Diadlo 2016-08-15 12:00:06 +03:00
parent 4bf4750975
commit 72780e6c7a
No known key found for this signature in database
GPG Key ID: 5AF9F2E29107C727
11 changed files with 20 additions and 23 deletions

View File

@ -345,7 +345,7 @@ bool Audio::initInput(const QString& deviceName)
qDebug() << "Opening audio input" << deviceName;
assert(!alInDev);
/// @todo Try to actually detect if our audio source is stereo
// TODO: Try to actually detect if our audio source is stereo
int stereoFlag = AUDIO_CHANNELS == 1 ? AL_FORMAT_MONO16 : AL_FORMAT_STEREO16;
const uint32_t sampleRate = AUDIO_SAMPLE_RATE;
const uint16_t frameDuration = AUDIO_FRAME_DURATION;

View File

@ -388,7 +388,7 @@ void FileTransferWidget::fileTransferRemotePausedUnpaused(ToxFile file, bool pau
void FileTransferWidget::fileTransferBrokenUnbroken(ToxFile file, bool broken)
{
/// @todo Handle broken transfer differently once we have resuming code
// TODO: Handle broken transfer differently once we have resuming code
if (broken)
onFileTransferCancelled(file);
}

View File

@ -267,8 +267,8 @@ void Core::start()
if (!id.isEmpty())
emit idSet(id);
/// @todo NOTE: This is a backwards compatibility check,
/// once most people have been upgraded away from the old HistoryKeeper, remove this
// TODO: This is a backwards compatibility check,
// once most people have been upgraded away from the old HistoryKeeper, remove this
if (Nexus::getProfile()->isEncrypted())
checkEncryptedHistory();

View File

@ -23,7 +23,7 @@
#define TOXAV_RINGING_TIME 45
/// @todo Put that in the settings
// TODO: Put that in the settings
#define TOXAV_MAX_VIDEO_WIDTH 1280
#define TOXAV_MAX_VIDEO_HEIGHT 720

View File

@ -471,12 +471,12 @@ void CoreFile::onFileRecvChunkCallback(Tox *tox, uint32_t friendId, uint32_t fil
void CoreFile::onConnectionStatusChanged(Core* core, uint32_t friendId, bool online)
{
/// @todo Actually resume broken file transfers
/// We need to:
/// - Start a new file transfer with the same 32byte file ID with toxcore
/// - Seek to the correct position again
/// - Update the fileNum in our ToxFile
/// - Update the users of our signals to check the 32byte tox file ID, not the uint32_t file_num (fileId)
// TODO: Actually resume broken file transfers
// We need to:
// - Start a new file transfer with the same 32byte file ID with toxcore
// - Seek to the correct position again
// - Update the fileNum in our ToxFile
// - Update the users of our signals to check the 32byte tox file ID, not the uint32_t file_num (fileId)
ToxFile::FileStatus status = online ? ToxFile::TRANSMITTING : ToxFile::BROKEN;
for (uint64_t key : fileMap.keys())
{

View File

@ -130,7 +130,7 @@ int main(int argc, char *argv[])
a.setApplicationVersion("\nGit commit: " + QString(GIT_VERSION));
#if defined(Q_OS_OSX)
/// @todo Add setting to enable this feature.
// TODO: Add setting to enable this feature.
//osx::moveToAppFolder();
osx::migrateProfiles();
#endif

View File

@ -664,7 +664,7 @@ QString Settings::getAppDataDirPath() const
+ "Library" + QDir::separator() + "Application Support" + QDir::separator() + "Tox")+QDir::separator();
#else
/**
* @todo change QStandardPaths::DataLocation to AppDataLocation when upgrate Qt to 5.4+
* TODO: Change QStandardPaths::DataLocation to AppDataLocation when upgrate Qt to 5.4+
* For now we need support Qt 5.3, so we use deprecated DataLocation
* BTW, it's not a big deal since for linux AppDataLocation and DataLocation are equal
*/

View File

@ -21,9 +21,7 @@
#if defined(__APPLE__) && defined(__MACH__)
#include "src/platform/capslock.h"
/**
* @todo implement for osx
*/
// TODO: Implement for osx
bool Platform::capsLockEnabled()
{
return false;

View File

@ -1010,7 +1010,7 @@ void ChatForm::SendMessageStr(QString msg)
}
else
{
/// @todo Make faux-offline messaging work partially with the history disabled
// TODO: Make faux-offline messaging work partially with the history disabled
ma->markAsSent(QDateTime::currentDateTime());
}

View File

@ -50,12 +50,11 @@ AboutForm::AboutForm()
Translator::registerHandler(std::bind(&AboutForm::retranslateUi, this), this);
}
/**
* @todo when we finally have stable releases: build-in a way to tell
* nightly builds from stable releases.
*/
void AboutForm::replaceVersions()
{
// TODO: When we finally have stable releases: build-in a way to tell
// nightly builds from stable releases.
QString TOXCORE_VERSION = QString::number(TOX_VERSION_MAJOR) + "." +
QString::number(TOX_VERSION_MINOR) + "." +
QString::number(TOX_VERSION_PATCH);

View File

@ -98,7 +98,7 @@ AVForm::~AVForm()
void AVForm::hideEvent(QHideEvent* event)
{
if (subscribedToAudioIn) {
/// @todo this should not be done in show/hide events
// TODO: This should not be done in show/hide events
Audio::getInstance().unsubscribeInput();
subscribedToAudioIn = false;
}
@ -121,7 +121,7 @@ void AVForm::showEvent(QShowEvent* event)
getVideoDevices();
if (!subscribedToAudioIn) {
/// @todo this should not be done in show/hide events
// TODO: This should not be done in show/hide events
Audio::getInstance().subscribeInput();
subscribedToAudioIn = true;
}