+mdictionary (2.0.0beta2) stable; urgency=low
+ * beta 2 release
+ * added stardict plugin
+ * added feature of browse, download and add xdxf dictionaries from http://xdxf.revdanica.com/down/ direct in mdictionary
+ * fixed some bugs
+ -- Marcin Kaźmierczak <marcin.kazmierczak@comarch.pl> Thu, 25 Nov 2010 15:49:20 +0100
mdictionary (2.0.0beta) stable; urgency=low
* beta release
* mdictionary 2.0.0 beta is a qt version of mdictionary
*******************************************************************************/
-//Created by Mateusz Półrola
+/*! \file MainWidget.cpp
+ \brief Implements widget for maemo that allows user to search quickly right from home screen using mdictionary.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "MainWidget.h"
*******************************************************************************/
-//! \file MainWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MainWidget.h
+ \brief Implements widget for maemo that allows user to search quickly right from home screen using mdictionary.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef MAINWIDGET_H
#define MAINWIDGET_H
#include <QtDBus/QDBusConnection>
#include <QPushButton>
-//! Implements widget for maemo that allows user to search quickly right from home screen using mdictionary.
/*!
Shows tool button with logo of mDictionary which can start application.
In line edit user inputs word, and after using button next to it or pressing enter, widget runs mDictionary which immediately starts searching for a given word.
*******************************************************************************/
-//Created by Mateusz Półrola
+/*! \file main.cpp
+ \brief Desktop widget's main file
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "MainWidget.h"
#include <QtGui/QApplication>
*******************************************************************************/
-/*! /file AccentsNormalizer.h
+/*! \file AccentsNormalizer.h
\brief Common functionality for all classes that need to remove accents from strings
+
\author Bartosz Szatkowski <bulislaw@linux.com>
*/
/*! \file DictDialog.h
\brief Interface for plugin dialog provider
+
\author Mateusz Półrola <mateusz.polrola@comarch.com>
*/
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file GUIInterface.h
-//! \brief Defines interface for GUI
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file GUIInterface.h
+ \brief Defines interface for GUI
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
*******************************************************************************/
-//Created by Mateusz Półrola
+/*! \file History.h
+ \brief Object with search history
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef HISTORY_H
#define HISTORY_H
*******************************************************************************/
-/*! /file Notify.h
+/*! \file Notify.h
\brief Declaration of common notify subsystem (NotifyType for now)
\author Bartosz Szatkowski <bulislaw@linux.com>
+/*******************************************************************************
+
+ This file is part of mDictionary.
+
+ mDictionary is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ mDictionary is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with mDictionary. If not, see <http://www.gnu.org/licenses/>.
+
+ Copyright 2010 Comarch S.A.
+
+*******************************************************************************/
+
+/*!
+ \file Bookmarks.cpp
+ \brief Bookmarks functionality - marking words as favorite, managing marked
+ words, searching in marked words (with cached translations)
+
+ \author Bartosz Szatkowski <bulislaw@linux.com>
+*/
+
#include "Bookmarks.h"
#include "BookmarkTranslations.h"
#include <QThread>
*******************************************************************************/
-//Created by Mateusz Półrola
+/*! \file History.cpp
+ \brief Object with search history
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "../../include/History.h"
#include <QDebug>
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file AboutWidget.cpp
-//! \brief Simple "about" widget - product, company, license info
-//! \author Bartosz Szatkowski <bulislaw@linux.com>
+/*! \file AboutWidget.cpp
+ \brief Simple "about" widget - product, company, license info
+
+ \author Bartosz Szatkowski <bulislaw@linux.com>
+*/
#include "AboutWidget.h"
+
AboutWidget::AboutWidget(GUIInterface *parent): QDialog(parent)
{
setModal(true);
*******************************************************************************/
-//! \file AboutWidget.h
-//! \brief Simple "about" widget - product, company, license info
-//! \author Bartosz Szatkowski <bulislaw@linux.com>
+/*! \file AboutWidget.h
+ \brief Simple "about" widget - product, company, license info
+
+ \author Bartosz Szatkowski <bulislaw@linux.com>
+*/
#ifndef ABOUTWIDGET_H
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file BookmarksWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file BookmarksWidget.cpp
+ \brief Implements bookmarks management widget. Allows user to show all
+ or remove all bookmarks
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "BookmarksWidget.h"
*******************************************************************************/
-//! \file BookmarksWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file BookmarksWidget.h
+ \brief Implements bookmarks management widget. Allows user to show all
+ or remove all bookmarks
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef BOOKMARKSWIDGET_H
#define BOOKMARKSWIDGET_H
#include <QtGui>
#include "../../include/GUIInterface.h"
-//! Implements bookmarks management widget
-/*!
- Allows user to show all or remove all bookmarks
-*/
class BookmarksWidget : public QDialog
{
Q_OBJECT
*******************************************************************************/
-//! \file DBusAdapter.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DBusAdapter.cpp
+ \brief Implements dbus adapter which defines dbus interface for an application.
+ Other application can use this interface to call mdictionary methods.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "DBusAdapter.h"
#include <QDebug>
*******************************************************************************/
-//! \file DBusAdapter.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DBusAdapter.h
+ \brief Implements dbus adapter which defines dbus interface for an application.
+ Other application can use this interface to call mdictionary methods.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef DBUSADAPTER_H
#define DBUSADAPTER_H
*******************************************************************************/
-//! \file DictManagerWidget.cpp
-//! \brief Dictionaries management widget
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictManagerWidget.cpp
+ \brief Implements dictionaries management widget
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "DictManagerWidget.h"
#include "DictTypeSelectDialog.h"
*******************************************************************************/
-//! \file DictManagerWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictManagerWidget.h
+ \brief Implements dictionaries management widget
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef DICTMANAGERWIDGET_H
#define DICTMANAGERWIDGET_H
#include "MenuWidget.h"
-//! Implements dictionaries management widget
/*!
Shows list of loaded dictionaries and their states (active/inactive).
It allows to change dicts states, add a new dict, remove selected one or
*******************************************************************************/
-//! \file DictTypeSelectDialog.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictTypeSelectDialog.cpp
+ \brief Implements plugin selection dialog
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "DictTypeSelectDialog.h"
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file DictTypeSelectDialog.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictTypeSelectDialog.h
+ \brief Implements plugin selection dialog
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef DICTTYPESELECTDIALOG_H
#define DICTTYPESELECTDIALOG_H
#define PLUGIN_ROW_ROLE 99 //TODO remove this
-//! Implements plugin selection dialog
/*!
Shows a list of loaded dictionaries plugins.
Static function addNewdict will return selected plugin.
*******************************************************************************/
-//! \file HistoryListDialog.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file HistoryListDialog.cpp
+ \brief Implements history list dialog
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "HistoryListDialog.h"
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file HistoryListDialog.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file HistoryListDialog.h
+ \brief Implements history list dialog
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef HISTORYLISTDIALOG_H
#define HISTORYLISTDIALOG_H
#include <QtGui>
-//! Implements history list dialog
/*!
Shows a history list and allows user to select one word of it.
On desktop it is shown as a popup.
*******************************************************************************/
-//! \file MainWindow.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MainWindow.cpp
+ \brief Implements interface for GUI
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "MainWindow.h"
#include <QtGui>
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file MainWindow.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MainWindow.h
+ \brief Implements interface for GUI
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef MAINWINDOW_H
#define MAINWINDOW_H
#include "NotifyManager.h"
-//! Implements interface for GUI
/*!
Creates all of GUI subcomponents, and connects all GUI interface signals
with suitable backbone signals and slots.
*******************************************************************************/
-//! \file MenuTabWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MenuTabWidget.cpp
+ \brief Menu's main widget
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "MenuTabWidget.h"
#include <QDebug>
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file MenuTabWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MenuTabWidget.h
+ \brief Menu's main widget
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef MENUTABWIDGET_H
#define MENUTABWIDGET_H
*******************************************************************************/
-//! \file MenuWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MenuWidget.cpp
+ \brief Displays custom menu with tab widget containing all submenus.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "MenuWidget.h"
#include <QDebug>
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file MenuWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file MenuWidget.h
+ \brief Displays custom menu with tab widget containing all submenus.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef MENUWIDGET_H
#define MENUWIDGET_H
*******************************************************************************/
-//! \file NotifyManager.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file NotifyManager.cpp
+ \brief Manages notifications in applications
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "NotifyManager.h"
#include <QMessageBox>
*******************************************************************************/
-//! \file NotifyManager.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file NotifyManager.h
+ \brief Manages notifications in applications
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef NOTIFYMANAGER_H
#define NOTIFYMANAGER_H
#include "../../include/Notify.h"
#include "MenuWidget.h"
-//! Manages notifications in applications
/*!
Shows notifications to user, assures that a couple of the same notifications
will not be displayed at the same time. It automatically deletes
*******************************************************************************/
-//! \file SearchBarWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file SearchBarWidget.cpp
+ \brief Displays search bar
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "SearchBarWidget.h"
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file SearchBarWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file SearchBarWidget.h
+ \brief Displays search bar
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef SEARCHBARWIDGET_H
#include "../backbone/backbone.h"
#include "../../include/History.h"
-//! Displays search bar
/*!
Contains line edit field to input word which user would like to find
and buttons to start/stop search and browse search history.
*******************************************************************************/
-//! \file SettingsWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictManagerWidget.cpp
+ \brief Implements applications settings widget
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "SettingsWidget.h"
#include <QDebug>
*******************************************************************************/
-//! \file DictManagerWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file DictManagerWidget.h
+ \brief Implements applications settings widget
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef SETTINGSWIDGET_H
#define SETTINGSWIDGET_H
#include "../../include/settings.h"
#include "SpinBox.h"
-//! Implements applications settings widget
/*!
Shows settings that user can change.
It allows to change limit of searches and limit of history.
*******************************************************************************/
-//Created by Mateusz Półrola
+/*! \file SpinBox.cpp
+ \brief Spin box
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "SpinBox.h"
*******************************************************************************/
-//Created by Mateusz Półrola
+/*! \file SpinBox.h
+ \brief Spin box
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef SPINBOX_H
#define SPINBOX_H
*******************************************************************************/
-//! \file TranslationView.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file TranslationView.cpp
+ \brief Web view with translations
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include <QtGui>
#include "TranslationView.h"
*******************************************************************************/
-//! \file TranslationView.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file TranslationView.h
+ \brief Web view with translations
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef TRANSLATIONVIEW_H
#define TRANSLATIONVIEW_H
*******************************************************************************/
-//! \file TranslationWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file TranslationWidget.cpp
+ \brief Displays translation of a word found in dictionaries
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "TranslationWidget.h"
#include <QDebug>
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file TranslationWidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file TranslationWidget.h
+ \brief Displays translation of a word found in dictionaries
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef TRANSLATIONWIDGET_H
#define TRANSLATIONWIDGET_H
#include <QPropertyAnimation>
#include "../../include/GUIInterface.h"
-//! Displays translation of a word found in dictionaries
/*!
Displays many translations of word, formatted as xml.
*/
*******************************************************************************/
-//! \file WelcomeScreenWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WelcomeScreenWidget.cpp
+ \brief Implements widget that displays welcome screen to user
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "WelcomeScreenWidget.h"
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file WelcomeScreenWidget.h
-//! \brief Implements widget that displays welcome screen to user
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WelcomeScreenWidget.h
+ \brief Implements widget that displays welcome screen to user
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef WELCOMESCREENWIDGET_H
#define WELCOMESCREENWIDGET_H
*******************************************************************************/
-//! \file WordListProxyStyle.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WordListProxyStyle.cpp
+ \brief Custom proxy style that draws checkboxes as stars.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "WordListProxyStyle.h"
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file WordListProxyStyle.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WordListProxyStyle.h
+ \brief Custom proxy style that draws checkboxes as stars.
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef WORDLISTPROXYSTYLE_H
#define WORDLISTPROXYSTYLE_H
#include <QProxyStyle>
#include <QtGui>
-//! Custom proxy style that draws checkboxes as stars.
-//! It will automatically wrap set style and change only
-//! checkboxes drawing.
+/*! Custom proxy style that draws checkboxes as stars.
+ It will automatically wrap set style and change only
+ checkboxes drawing.
+*/
class WordListProxyStyle : public QProxyStyle
{
public:
*******************************************************************************/
-//! \file WordListWidget.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WordListwidget.cpp
+ \brief Displays list of words found in dictionaries
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include "WordListWidget.h"
#include "WordListProxyStyle.h"
Copyright 2010 Comarch S.A.
*******************************************************************************/
-//! \file WordListwidget.h
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file WordListwidget.h
+ \brief Displays list of words found in dictionaries
+
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#ifndef WORDLISTWIDGET_H
#define WORDLISTWIDGET_H
#include "../backbone/backbone.h"
#include "WordListProxyStyle.h"
-//! Displays list of words found in dictionaries
/*!
It allows user to select word to see its translation or to mark or unmark
it as "star" (add/remove from bookmarks). It inherits from QTreeView
*******************************************************************************/
-//! \file main.cpp
-//! \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+/*! \file main.cpp
+ \brief mDictionary's main file
+ \author Mateusz Półrola <mateusz.polrola@comarch.pl>
+*/
#include <QtGui/QApplication>
#include "MainWindow.h"
*******************************************************************************/
/*!
- \file GoogleSettingsDialog.cpp
+ \file GoogleDialog.cpp
+ \brief Implementation of google plugin's dialogs.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
- \file GoogleDialog.cpp
+ \file GoogleDialog.h
+ \brief Implementation of google plugin's dialogs.
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
#include <QtGui>
#include "GooglePlugin.h"
-//! Implementation of google plugin's dialogs.
/*!
This class can create dialogs for adding a new dictionary or changing settings
of an existing one, based on dialog type passed to constructor.
Copyright 2010 Comarch S.A.
*******************************************************************************/
-/*!
- \file GoogleDictDialog.cpp
+/*! \file GoogleDictDialog.cpp
+ \brief Class launches dialog which generates a new dictionary, or changes
+ settings
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
/*! \file GoogleDictDialog.h
\brief Class launches dialog which generates a new dictionary, or changes
settings
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file GooglePlugin.cpp
+ \brief Implementation of google plugin's main class.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file GooglePlugin.h
+ \brief Implementation of google plugin's main class.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
-/*! \file TranslationGoogle.cpp
+/*!
+ \file TranslationGoogle.cpp
+ \brief Implementation of google plugin's translation.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file TranslationGoogle.h
+ \brief Implementation of google plugin's translation.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file CompressedReader.cpp
+ \brief Class implementing StarDictReader interface and handling reading from compressed
+ files like .gz or .dz
+
\author Mateusz Półrola
*/
*******************************************************************************/
/*!
- \file CompressedReader.cpp
+ \file CompressedReader.h
+ \brief Class implementing StarDictReader interface and handling reading from compressed
+ files like .gz or .dz
+
\author Mateusz Półrola
*/
#include "StarDictReader.h"
/*!
- Class implementing StarDictReader interface and handling rading from compressed
+ Class implementing StarDictReader interface and handling reading from compressed
files like .gz or .dz, using zlib
*/
class CompressedReader : public StarDictReader
*******************************************************************************/
/*!
\file StarDialog.cpp
+ \brief Implementation of stardict plugin's dialogs.
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
*/
*******************************************************************************/
/*!
\file StarDialog.h
+ \brief Implementation of stardict plugin's dialogs.
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
*/
#include "StarDictPlugin.h"
-//! Implementation of stardict plugin's dialogs.
/*!
This class can create dialogs for adding a new dictionary or changing settings
of an existing one, based on dialog type passed to contructor.
*******************************************************************************/
/*!
\file StarDictDialog.cpp
+ \brief Class launches dialog which generates a new dictionary, or changes
+ settings
+
\author Mateusz Półrola
*/
*******************************************************************************/
/*!
\file StarDictDialog.h
+ \brief Class launches dialog which generates a new dictionary, or changes
+ settings
+
\author Mateusz Półrola
*/
class StarDictPlugin;
-//! Implementation of DictDialog interface for starDict plugin
class StarDictDialog : public DictDialog {
Q_OBJECT
public:
*******************************************************************************/
/*!
\file StarDictPlugin.cpp
+ \brief Implementation of stardict plugin's main class.
+
\author Jakub Jaszczynski
*/
*******************************************************************************/
/*!
\file StarDictPlugin.h
+ \brief Implementation of stardict plugin's main class.
+
\author Jakub Jaszczynski
*/
*******************************************************************************/
/*!
\file StarDictReader.h
+ \brief Abstract class used for reading stardict dict and idx files.
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file StarDictReaderFactory.cpp
+ \brief Class used to creating StarDictReader objects, based on filename it creates
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file StarDictReaderFactory.h
+ \brief Class used to creating StarDictReader objects, based on filename it creates
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file TranslationStarDict.cpp
+ \brief Implementation of stardict plugin's translation.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file TranslationStarDict.h
+ \brief Implementation of stardict plugin's translation.
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file UncompressedReader.cpp
+ \brief Class implementing StarDictReader interface and handling
+ reading from uncompressed files
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file UncompressedReader.h
+ \brief Class implementing StarDictReader interface and handling
+ reading from uncompressed files
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
/*!
Class implementing StarDictReader interface and handling
- rading from uncompressed files
+ reading from uncompressed files
*/
class UncompressedReader : public StarDictReader
{
*******************************************************************************/
/*!
\file DictsModel.cpp
+ \brief Item model for informations about xdxf dictionaries.
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file DictsModel.h
+ \brief Item model for informations about xdxf dictionaries.
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file DictsProxyModel.h
+ \brief roxy model used for filtering and sorting informations about xdxf dictionaries.
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
*/
/*!
\file DownloadDict.h
\brief Represenation of dictionary html entry on XDXF webpage
+
\author Bartosz Szatkowski <bulislaw@linux.com>
*/
*******************************************************************************/
/*!
- \file HttpDownloader.h
+ \file HttpDownloader.cpp
+ \brief Downloader for xdxf dictionaries
+
\author Bartosz Szatkowski <bulislaw@linux.com>
*/
*******************************************************************************/
/*!
\file HttpDownloader.h
+ \brief Downloader for xdxf dictionaries
+
\author Bartosz Szatkowski <bulislaw@linux.com>
*/
*******************************************************************************/
/*!
\file TranslationXdxf.cpp
+ \brief Implementation of xdxf plugin's translation.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file TranslationXdxf.h
+ \brief Implementation of xdxf plugin's translation.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
#ifndef TRANSLATIONXDXF_H
*******************************************************************************/
/*!
\file XdxfCachingDialog.cpp
+ \brief Shows dialog with progress of dictionary caching
+
\author Mateusz Półrola
*/
*******************************************************************************/
/*!
\file XdxfCachingDialog.h
+ \brief Shows dialog with progress of dictionary caching
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
*/
class XdxfPlugin;
-//! Shows dialog with progress of dictionary caching
/*!
Displays progress bar and estimated time left of caching
*/
*******************************************************************************/
/*!
\file XdxfDialog.cpp
+ \brief Implementation of xdxf plugin's dialogs.
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
*/
/*!
\file XdxfDialog.h
+ \brief Implementation of xdxf plugin's dialogs.
+
\author Mateusz Półrola <mateusz.polrola@gmail.com>
*/
#include "xdxfplugin.h"
-//! Implementation of xdxf plugin's dialogs.
/*!
This class can create dialogs for adding a new dictionary or changing settings
of an existing one, based on dialog type passed to contructor.
*******************************************************************************/
/*!
\file XdxfDictDialog.cpp
+ \brief Implementation of DictDialog interface for xdxf plugin
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file XdxfDictDialog.h
+ \brief Implementation of DictDialog interface for xdxf plugin
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
class XdxfPlugin;
-//! Implementation of DictDialog interface for xdxf plugin
class XdxfDictDialog : public DictDialog {
Q_OBJECT
public:
*******************************************************************************/
/*!
\file XdxfDictDownloadProgressDialog.cpp
+ \brief Shows downloading progress bar.
+
\author Mateusz Półrola <mateusz.polrola@comarch.com>
*/
*******************************************************************************/
/*!
\file XdxfDictDownloadProgressDialog.h
+ \brief Shows downloading progress bar.
+
\author Mateusz Półrola <mateusz.polrola@comarch.com>
*/
*******************************************************************************/
/*!
\file XdxfDictDownloader.cpp
+ \brief XdxfDictDownloader is responsible for getting dict list from XDXF website
+ and other actions necessary to download and add dictionary
+
\author Mateusz Półrola <mateusz.polrola@comarch.com>
*/
*******************************************************************************/
/*!
\file XdxfDictDownloader.h
+ \brief XdxfDictDownloader is responsible for getting dict list from XDXF website
+ and other actions necessary to download and add dictionary
+
\author Mateusz Półrola <mateusz.polrola@comarch.pl>
*/
*******************************************************************************/
/*!
\file XdxfDictSelectDialog.cpp
+ \brief Shows dialog with list of dictionaries allowing user
+ to select one of them.
+
\author Mateusz Półrola <mateusz.polrola@comarch.com>
*/
*******************************************************************************/
/*!
\file XdxfDictSelectDialog.h
+ \brief Shows dialog with list of dictionaries allowing user
+ to select one of them.
+
\author Mateusz Półrola <mateusz.polrola@comarch.com>
*/
*******************************************************************************/
/*!
\file xdxfplugin.cpp
+ \brief Implementation of xdxf plugin's main class.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
*******************************************************************************/
/*!
\file xdxfplugin.h
+ \brief Implementation of xdxf plugin's main class.
+
\author Jakub Jaszczynski <j.j.jaszczynski@gmail.com>
*/
projects / mdictionary / commitdiff