|
Last change
on this file since 67a9d5 was 750cff, checked in by Frederik Heber <heber@…>, 14 years ago |
|
HUGE: Update on documenation.
- a general skeleton of the documentation is now in place with all the major
components of MoleCuilder explained to some extent.
- some information has been transfered from TRAC (e.g. install procecure) into
this doxygen documentation where it is general and not specific to the
situation at our institute.
|
-
Property mode
set to
100644
|
|
File size:
1.0 KB
|
| Rev | Line | |
|---|
| [750cff] | 1 | /*
|
|---|
| 2 | * Project: MoleCuilder
|
|---|
| 3 | * Description: creates and alters molecular systems
|
|---|
| 4 | * Copyright (C) 2010 University of Bonn. All rights reserved.
|
|---|
| 5 | * Please see the LICENSE file or "Copyright notice" in builder.cpp for details.
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /**
|
|---|
| 9 | * \file logger.dox
|
|---|
| 10 | *
|
|---|
| 11 | * Created on: Oct 31, 2011
|
|---|
| 12 | * Author: heber
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 | /**
|
|---|
| 16 | * \page logger Logging
|
|---|
| 17 | *
|
|---|
| 18 | * In order to have conforming way of giving information about the current
|
|---|
| 19 | * doings of the program, there is a logging faculty with varying degree.
|
|---|
| 20 | *
|
|---|
| 21 | * It used in the following way:
|
|---|
| 22 | * \code
|
|---|
| 23 | * LOG(<level>, <msg>);
|
|---|
| 24 | * \endcode
|
|---|
| 25 | * where \a <level> is the verbosity level above which the message should be
|
|---|
| 26 | * given and <msg> is the message.
|
|---|
| 27 | *
|
|---|
| 28 | * Note that LOG() is just a define and \a <msg> may be a stream, hence
|
|---|
| 29 | * \code "bla" << bla << ", more bla" is valid.
|
|---|
| 30 | *
|
|---|
| 31 | * For giving errors you may use:
|
|---|
| 32 | * \code
|
|---|
| 33 | * ELOG(<level>, <msg>);
|
|---|
| 34 | * \endcode
|
|---|
| 35 | * where the program will exit automatically if the \a <level> is either
|
|---|
| 36 | * critical(0) or error(1). (2) emits a warning, all else should be ignorable.
|
|---|
| 37 | *
|
|---|
| 38 | *
|
|---|
| 39 | * \date 2011-10-31
|
|---|
| 40 | *
|
|---|
| 41 | */
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
