Changeset 201

Show
Ignore:
Timestamp:
01/28/06 00:52:54 (3 years ago)
Author:
edmanm
Message:

Doxygenate a couple files.

Location:
trunk/src/gui
Files:
3 modified

Legend:

Unmodified
Added
Removed
  • trunk/src/gui/main.cpp

    r95 r201  
    11/**************************************************************** 
    2  *  $Id$ 
    3  *  
    42 *  Vidalia is distributed under the following license: 
    53 * 
     
    2220 ****************************************************************/ 
    2321 
     22/** \file main.cpp 
     23 * \version $Id$ 
     24 * Contains the main Vidalia entry point. 
     25 * On Mac, it will use the native Mac style and use the Plastique style on all 
     26 * other platforms. 
     27 */ 
     28  
    2429#include <QApplication> 
    2530 
     
    3237#include "mainwindow.h" 
    3338 
     39 
     40/** Main application entry point. */ 
    3441int  
    3542main(int argc, char *argv[]) 
  • trunk/src/gui/mainwindow.cpp

    r197 r201  
    11/**************************************************************** 
    2  *  $Id$ 
    3  *  
    42 *  Vidalia is distributed under the following license: 
    53 * 
     
    2220 ****************************************************************/ 
    2321 
     22/** \file mainwindow.cpp 
     23 * \version $Id$ 
     24 * 
     25 * Implements the main window. The main window is a hidden window that serves 
     26 * as the parent of the tray icon and popup menu, as well as other application 
     27 * dialogs. 
     28 */ 
     29 
    2430#include <QtGui> 
    2531 
     
    3844 
    3945 
    40 /** Default constructor */ 
     46/** Default constructor. It installs an icon in the system tray area and 
     47 * creates the popup menu associated with that icon. */ 
    4148MainWindow::MainWindow() 
    4249{ 
     
    123130} 
    124131 
    125 /*  
    126   Create and bind actions to events. Setup for initial 
    127   tray menu configuration. 
    128 */ 
     132/** Create and bind actions to events. Setup for initial 
     133 * tray menu configuration. */ 
    129134void  
    130135MainWindow::createActions() 
     
    159164} 
    160165 
    161 /* 
    162   Creates a QMenu object that contains QActions 
    163   which compose the system tray menu. 
    164 */ 
     166/** 
     167 * Creates a QMenu object that contains QActions 
     168 * which compose the system tray menu. 
     169 */ 
    165170void  
    166171MainWindow::createMenus() 
     
    214219} 
    215220 
    216 /** Removes the menubar. */ 
     221/** Removes the menubar (Mac only). */ 
    217222void 
    218223MainWindow::removeMenuBar() 
     
    225230} 
    226231 
    227 /* 
    228  Starts Tor, modifies tray icon and tray menu appropriately 
    229 */ 
     232/** Attempts to start Tor. If starting Tor fails, then it will display a 
     233 * message box giving the user an error message regarding why Tor failed to 
     234 * start. 
     235 * \sa started() 
     236 */ 
    230237void  
    231238MainWindow::start() 
     
    273280} 
    274281 
    275 /* 
    276  Stops Tor 
    277 */ 
     282/** Disconnects the control socket and stops the Tor process. */ 
    278283void  
    279284MainWindow::stop() 
     
    363368} 
    364369 
    365 /* 
    366  Creates an instance of AboutDialog and shows it  
    367 */ 
     370/** Creates an instance of AboutDialog and shows it. If the About dialog is 
     371 * already displayed, the existing instance will be brought to the foreground. */ 
    368372void  
    369373MainWindow::showAbout() 
     
    378382} 
    379383 
    380 /* 
    381  Shows Message Log 
    382 */ 
     384/** Shows Message Log. If the message log is already displayed, the existing 
     385 * instance will be brought to the foreground. */ 
    383386void 
    384387MainWindow::showMessageLog() 
     
    392395} 
    393396 
    394 /* 
    395  Shows Bandwidth Graph 
    396 */ 
     397/** Shows Bandwidth Graph. If the bandwidth graph is already displayed, the 
     398 * existing instance will be brought to the foreground. */ 
    397399void 
    398400MainWindow::showBandwidthGraph() 
     
    405407  } 
    406408} 
     409 
  • trunk/src/gui/mainwindow.h

    r188 r201  
    2424#ifndef _MAINWINDOW_H 
    2525#define _MAINWINDOW_H 
     26 
     27/** \file mainwindow.h 
     28 * \version $Id$ 
     29 */ 
    2630 
    2731#include <QMainWindow>