Commit 925652b4 authored by Gilles Caulier's avatar Gilles Caulier 🗼
Browse files

fix file header

parent 7ab3ae1e
......@@ -152,7 +152,7 @@ if(KF5Kipi_FOUND)
message(STATUS "")
message(STATUS "----------------------------------------------------------------------------------")
message(STATUS " ${PROJECT_NAME} ${KIPIPLUGINS_VERSION_STRING} dependencies results <http://www.digikam.org>")
message(STATUS " ${PROJECT_NAME} ${KIPIPLUGINS_VERSION_STRING} dependencies results")
message(STATUS "")
# Require shared libraries results.
......
This file's purpose is to guide contributors and developers to help on the
digiKam project.
this project.
========================================================================
10 golden rules for starting with open source
========================================================================
Before to contribute to digiKam project, please take a look to this link:
Before to contribute, please take a look to this link:
http://schlitt.info/applications/blog/index.php?/archives/541-10-golden-rules-for-starting-with-open-source.html
......@@ -13,7 +13,7 @@ http://schlitt.info/applications/blog/index.php?/archives/541-10-golden-rules-fo
Source code formatting:
========================================================================
Adhere to this style guide strictly while adding new code to digiKam or
Adhere to this style guide strictly while adding new code or
working on existing code.
-------------------------------------------------------------------------
......@@ -129,7 +129,7 @@ Class, file and Variable names:
-------------------------------------------------------------------------
- private member variables must be stored in a d private container to reduce
compilation time and improve binary compatibility between digiKam components.
compilation time and improve binary compatibility between components.
See more information how to use a 'd' private class at this url:
http://developer.kde.org/policies/librarypolicy.html
......@@ -154,8 +154,7 @@ a = (b == foobar) ? 1 : -1; // you are asking for trouble by putting comments he
Header files
========================================================================
- Add copyright to top of every file. Use the same header than others digiKam
source code.
- Add copyright to top of every file. Use the same header than others source code.
- Double inclusion protection defines are all upper case letters and are
composed of the classname and a H suffix separated by underscore
......@@ -182,9 +181,9 @@ General recommendations
========================================================================
Please take a look into KDE contrib page tips before to write code/patches for
digiKam project : http://techbase.kde.org/Contribute
this project : http://techbase.kde.org/Contribute
Use the same .cpp/.h header than the rest of digiKam project.
Use the same .cpp/.h header than the rest of the project.
Use a decent editor which does auto-indentation/syntax-highlighting for you.
I personally use Emacs (Renchi) or Kdevelop (Gilles).
......@@ -204,8 +203,8 @@ Just to give a taste of what i can do with emacs (and kdesdk):
GDB Backtrace
========================================================================
If you found a context to crash digiKam, you can provide a backtrace using GDB debugger.
digiKam need to be compiled with all debug info else the backtrace will not suitable.
If you found a context to crash, you can provide a backtrace using GDB debugger.
All need to be compiled with all debug info else the backtrace will not suitable.
There is a configure option for that:
# make -f Makefile.cvs
......@@ -216,7 +215,7 @@ There is a configure option for that:
To make a backtrace with GDB use following command:
# gdb digikam
# gdb
> run
> ...
> _crash here_
......@@ -235,10 +234,10 @@ http://techbase.kde.org/Development/Tutorials/Debugging/Debugging_on_MS_Windows
Memory leak
========================================================================
To check any memory leak problem in digiKam, valgrind is your friend (http://valgrind.org)
To check any memory leak problem, valgrind is your friend (http://valgrind.org)
Try this command line to use with valgrind :
valgrind --tool=memcheck --leak-check=full --error-limit=no digikam
valgrind --tool=memcheck --leak-check=full --error-limit=no
========================================================================
Profiling with cachegrind
......@@ -246,12 +245,12 @@ Profiling with cachegrind
Valgrind also includes a tool to find out in which parts of your code time is spent.
valgrind --tool=callgrind digikam
valgrind --tool=callgrind
Profiling can be disabled at startup to limit the output to the code you are interested in.
Start with
valgrind --tool=callgrind --instr-atstart=no digikam
valgrind --tool=callgrind --instr-atstart=no
and prepare the situation you want to profile. Then, in another console, start profiling with
"callgrind_control -i on" and, after the situation has passed, request a profile dump with
......@@ -297,13 +296,13 @@ Speed up the code-compile-test cycle
Assuming you have setup your environment in ~/.bashrc as is suggested for KDE4 development,
you can add something like this to your ~/.bashrc:
function digikam_start {
LD_LIBRARY_PATH=${KDE_BUILD}/extragear/graphics/lib:${LD_LIBRARY_PATH} ${KDE_BUILD}/extragear/graphics/digikam/digikam/digikam
function _start {
LD_LIBRARY_PATH=${KDE_BUILD}/extragear/graphics/lib:${LD_LIBRARY_PATH} ${KDE_BUILD}/extragear/graphics///
}
function digikam_start_gdb {
LD_LIBRARY_PATH=${KDE_BUILD}/extragear/graphics/lib:${LD_LIBRARY_PATH} gdb ${KDE_BUILD}/extragear/graphics/digikam/digikam/digikam
function _start_gdb {
LD_LIBRARY_PATH=${KDE_BUILD}/extragear/graphics/lib:${LD_LIBRARY_PATH} gdb ${KDE_BUILD}/extragear/graphics///
}
This allows you to run digikam after compiling without the need of a "make install", even
This allows you to run after compiling without the need of a "make install", even
if you changed code in the libraries.
......@@ -7,7 +7,7 @@
macro(DETECT_LIBKIPI MIN_VERSION)
if (NOT DIGIKAMSC_COMPILE_LIBKIPI)
if (NOT LOCAL_COMPILE_LIBKIPI)
message(STATUS "libkipi : search system based library")
find_package(KF5Kipi ${MIN_VERSION})
......@@ -78,7 +78,7 @@ endmacro()
macro(DETECT_LIBKVKONTAKTE MIN_VERSION)
if (NOT DIGIKAMSC_COMPILE_LIBKVKONTAKTE)
if (NOT LOCAL_COMPILE_LIBKVKONTAKTE)
message(STATUS "libkvkontakte : search system based library")
find_package(KF5Vkontakte ${MIN_VERSION} QUIET)
......@@ -117,7 +117,7 @@ endmacro()
macro(DETECT_LIBMEDIAWIKI MIN_VERSION)
if (NOT DIGIKAMSC_COMPILE_LIBMEDIAWIKI)
if (NOT LOCAL_COMPILE_LIBMEDIAWIKI)
message(STATUS "libmediawiki : search system based library")
find_package(KF5MediaWiki ${MIN_VERSION} QUIET)
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2004-05-04
* Description : Batch progress dialog
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2004-05-04
* Description : Batch progress dialog
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2004-05-01
* Description : image files selector dialog.
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2004-05-01
* Description : image files selector dialog.
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2015-11-12
* Description : a common login dialog for kipi plugins
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2015-11-12
* Description : a common login dialog for kipi plugins
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2015-08-01
* Description : new album creation dialog.
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2015-08-01
* Description : new album creation dialog.
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2012-04-04
* Description : Tool dialog
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2012-04-04
* Description : Tool dialog
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2009-11-13
* Description : a template to create wizzard page.
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2009-11-13
* Description : a template to create wizzard page.
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2006-14-09
* Description : Kipi-Plugins shared library.
......@@ -99,7 +99,7 @@ void KPAboutData::addAuthor(const QString& name, const QString& role, const QStr
void KPAboutData::slotHelp()
{
QUrl url = QUrl(QString::fromUtf8("help:/%1/index.html").arg(QString::fromLatin1("digikam")));
QUrl url = QUrl(QString::fromUtf8("help:/%1/index.html").arg(QString::fromLatin1("kipi-plugins")));
if (!m_handbookEntry.isEmpty())
{
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2006-14-09
* Description : Kipi-Plugins shared library.
......@@ -51,7 +51,7 @@ public:
explicit KPAboutData(const KLocalizedString& tool,
const KLocalizedString& description = KLocalizedString(),
const KLocalizedString& copyright = ki18n("Copyright 2003-2016, digiKam developers team"));
const KLocalizedString& copyright = ki18n("Copyright 2003-2016, KDE developers team"));
KPAboutData(const KPAboutData& other);
virtual ~KPAboutData();
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2012-02-06
* Description : help wrapper around libkipi ImageInfo to manage easily
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2012-02-06
* Description : help wrapper around libkipi ImageInfo to manage easily
......
/* ============================================================
*
* This file is a part of digiKam project
* http://www.digikam.org
* This file is a part of KDE project
*
*
* Date : 2015-09-09
* Description : Kipi-Plugins shared library.
......
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