Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Added some comments and corrections
  • Loading branch information
patrickelectric committed Mar 12, 2016
1 parent 0d22d0e commit c775346
Show file tree
Hide file tree
Showing 71 changed files with 711 additions and 79 deletions.
2 changes: 1 addition & 1 deletion IDEApplication.cpp
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Copyright (C) 2011
Expand Down
2 changes: 1 addition & 1 deletion IDEApplication.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Copyright (C) 2011
Expand Down
2 changes: 1 addition & 1 deletion IDEGlobal.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/IDEdbg.cpp
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/IDEdbg.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/IDEdbgConstants.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/IDEdbgPrivate.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/frame.cpp
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/frame.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/linked_list.cpp
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/linked_list.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/variable.cpp
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
2 changes: 1 addition & 1 deletion data/libraries/IDEdbg/variable.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
3 changes: 1 addition & 2 deletions env/Board.cpp
Expand Up @@ -2,8 +2,7 @@
Board.cpp
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down
60 changes: 59 additions & 1 deletion env/Board.h
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down Expand Up @@ -34,23 +34,81 @@ This program is free software; you can redistribute it and/or modify
#include <QHash>
#include <QMap>

/**
* @brief A class to help deal with boards.txt
*
*/

class Board
{
public:

/**
* @brief Return the name of the board
* e.g: uno.name="Arduino Uno"
*
* @return const QString&
*/
const QString& name() const;


/**
* @brief Return all Ids of the boards in boards.txt
*
* @return QStringList
*/
static QStringList boardIds();


/**
* @brief Return a pointer to Board class with the board information.
*
* @param name The board name. e.g: "uno" (uno.name=Arduino Uno)
* @return const Board*
*/
static const Board *boardInfo(const QString &name);

/**
* @brief Return the path of hardware directory
*
* @return QString
*/
QString hardwarePath() const { return mHardwarePath; };

/**
* @brief Return the value of an attribute
*
* @param attr attribute name. e.g: "name" (uno.name=Arduino Uno)
* @return QString
*/
QString attribute(const QString &attr) const;

/**
* @brief Stores all board's attribute
*
*/
QHash<QString, QString> mAttributes;

/**
* @brief save all boards in mBoards
*
*/
static QMap<QString, Board> mBoards;

private:

/**
* @brief Function that read boards.txt to identify all compatible boards
*
* @return void
*/
static void listBoards();


/**
* @brief Check if boards.txt has already been read
*
*/
static bool mListed;

QString mHardwarePath;
Expand Down
2 changes: 1 addition & 1 deletion env/Builder.cpp
Expand Up @@ -3,7 +3,7 @@
This file is part of arduide, The Qt-based IDE for the open-source Arduino electronics prototyping platform.
Copyright (C) 2010-2012
Copyright (C) 2010-2016
Authors : Denis Martinez
Martin Peres
Expand Down

0 comments on commit c775346

Please sign in to comment.