Sonntag, 22. Februar 2015

Datei-Templates in Eclipse anpassen für Doxygen

Datei Templates bieten die Möglichkeit, beim Erstellen einer Datei bereits vorgefertigte Textelemente einzubinden. Dazu gehört beispielsweise die Dokumentation am Anfang einer Datei. Dabei sind Dateiname, Autor oder Datei-Beschreibung enthalten.

Diese Informationen sind auch für Doxygen interessant und werden in die Softwaredokumentation aufgenommen. Also liegt es Nahe, beides zu kombinieren.

1. In Eclipse unter Window den Punkt Preferences aufrufen. Auf der linken Seite C/C++, Code Style und Code Templates auswählen.

2. Auf der rechten Seite den Punkt Comments auswählen und dann File. Diese kann dann mit dem Edit Button bearbeitet werden. Im Beispiel werden @file, @author, @date, @version und @brief eingefügt. Hier als Version für copy & paste.

/*!
 * @file    : $(file_name)
 * @author  : $(user)
 * @date    : $(date)
 * @version : 0.0
 * @brief   : Short description
 */


3. Beispieldatei erstellen. In Eclipse den Ordner auswählen in den die neue Datei eingefügt werden soll.


4. Eine neue Source Datei erstellen.

5. Name für die Datei angeben (gewünschte Endung angeben) und das Template auswählen (in diesem Beispiel für C).

6. Die erstellte Datei enthält nun vorausgewählt den Datei-Header mit den Doxygen-Kommentaren. Die Werte sind soweit möglich von Eclipse vorausgefüllt (Datum, Dateiname, Autor).



Viel Spaß beim Erstellen eigener Templates.

Installation von Doxygen, Eclox und Graphviz in Eclipse

Die Dokumentation mit Doxygen bietet sich an, um den Quelltext zu beschreiben. In Eclipse gibt es das Plugin eclox, um Doxygen einzubinden und komfortabel zu verwalten. Dieser Beitrag beschreibt die Installation von Doxygen zur Dokumentation, eclox zur Steuerung über Eclipse und Graphviz um grafische Anzeigen (Call Graph) zu erzeugen.

[Hier] geht es weiter.

Donnerstag, 19. Februar 2015

Eclipse-Projekt per Tastenkombination schließen

Rechte Maustaste, Suchen nach Projekt schließen und Klick. Das war mir jetzt etwas zu aufwendig, also habe ich einfach eine Tastenkombination erstellt um im Projektexplorer ein Projekt zu schließen. Ctrl+Shift+C.

Wie es geht, steht [hier]

Mittwoch, 18. Februar 2015

Breakpoints in Eclipse mit GNU ARM Plugin verwenden

Breakpoints in Eclipse mit GNU ARM Plugin verwenden

Breakpoints sind für jeden Entwickler ein Segen. Irgendetwas am Code ist immer fehlerhaft und diese Fehler sieht man nicht. Bis man ihn gefunden hat, dann wundert man sich, dass er nicht sofort ins Auge gesprungen ist.

Weiter geht es [hier].

Dienstag, 3. Februar 2015

Register View in Eclipse

Den Wert eines Registers, oder sogar der einzelnen Werten mit einem symbolischen Namen sehen. Das ist beim debuggen viel Wert. In Eclipse wird dies durch das ARM GCC Plugin ermöglicht. Zu allen Prozessoren, die zuvor mit einem Pack installiert wurden können die Register angezeigt werden.

[Hier] die Beschreibung und wie ihr es selbst einstellen könnt.

Eclipse, eine tolle Entwicklungsumgebung die mit Packs noch besser wird

Jetzt werden Daten in Eclipse geladen

Eine super Erweiterung für das ARM GCC Plugin sind die Packs. Es werden wichtige Daten wie Datenblätter für einen Prozessor heruntergeladen und es stehen zusätzliche Daten für das Debugging zur Verfügung.

Lest [hier] den Artikel zur Installation und einem einfachen Beispiel. 

Montag, 2. Februar 2015

Screenshots anfertigen und automatisch speichern

Worum geht es?

Für das Erstellen der Anleitungen brauchte ich das erste mal die Funktion, dass ich einen Screenshot per Tastenfolge erstellen wollte und dieser sofort gespeichert wird. Dabei wollte ich nicht erst irgendein Grafikprogramm öffnen und den Screenshot einfügen, Speichern unter und dann einen Dateinamen auswählen.

Also ging ich auf die Suche nach einem Tool, welches diese Funktion vereinfacht und automatisiert. Durch eine Goolge-Suche und Lesen von einigen Beiträgen im Internet, habe ich mich für infanview entschieden. Die Software habe ich vor vielen Jahren schon verwendet und sie als zuverlässig in Erinnerung. Die Auswahl ist alse kein Ergebnis eines wissenschaftlich wasserfesten Vergleiches.

Installation von irfanview

1. Herunterladen der [aktuellen Version] vom Heise-Softwareverzeichnis. Der Verlag ist mir als langjähriger Leser der c't vertrauenswürdig genug für einen download.

2. Die Standardinstallation ohne Änderungen



3. Einstellung des Zielordners beim Erstellen der Screenshots.



4. Einstellung des aufzunehmenden Screenshots (hier Vordergrund-Fenster) und Speicherort für die Screenshots. Der Dateiname kann auch vielfältigen Anpassungen unterzogen werden. Ich verwende den Standardnamen und das Standard-Tastatur-Kürzel STRG-F11



Das wars. Wenn ihr jetzt Strg und F11 gleichzeitig drückt wird ein Screenshot des aktuellen Fensters vorgenommen und dieses am gewählten Ort gespeichert.

Viel Spass beim Erstellen von Screenshots.



Das blöde Thema mit den kleinen vergessenen Merkmalen in Screenshots

Was ist das Problem?

Oft ist man beim Erstellen von Anleitungen, Tutorials oder Sonstwas mit Screenshots so auf den Inhalt konzentriert, dass man die Bilder gar nicht mehr so extrem genau anschaut.

Leider enthält so ein Monitor von dem ein Screenshot angefertigt wird, nicht nur den gerade geplanten Inhalt. Es gibt so viele Kleinigkeiten, die vielleicht nicht unbedingt in die große weite Welt des Internets verstreut werden soll.

Als Beispiele was man so alles auf einem Screenshot vergessen kann fallen mir ein:

  • Ein offenes Chat-Fenster mit Namenslisten und Chatinhalten
  • Ein Browser-Tab dessen Name vielleicht zuviel über den Inhalt Preis gibt (Politische Partei, Zeitschriften mit besonderem Bezug, Nacktbilder, ...)
  • Hintergrundbild vom letzten Strandurlaub mit der eigenen Freundin oder Kindern
  • Ein Fenster mit persönlichen Daten (Kreditdaten, Telefonnummern, Adressen, ...)
  • Rechtschreibfehler auf dem Hauptinhalt

Was kann man dagegen tun?


Konzentration und Gegenlesen. 

Das wolltet ihr wahrscheinlich nicht hören. Aber es hilft. Im Gegensatz zu irgendwelchen Automatiken könnt ihr selbst mit zeitlichem Abstand oder jemand anderes viele Fehler finden. Der Vorschlag ist, jeden Blog-Eintrag immer nur als Entwurf zu schreiben, und dann mindestens eine Nacht oder länger nicht mehr anschauen.
Erst dann den Blogeintrag und ganz bewußt auch die Bilder erneut kontrollieren. Dabei darauf achten, 
  • ob persönliche Daten enthalten sind, 
  • ob nur wesentliche Inhalte drauf sind und 
  • ob das Bild wirklich nur den gewünschten Inhalt enthält. 
Erst wenn dies nicht der Fall ist, sollte der Blogeintrag inklusive Bildern wirklich hoch geladen, bzw. aktiviert werden. Was einmal im Netz ist - ist im Netz. Durch Twitter und Facebook verbreiten sich insbesondere die Inhalte, die am peinlichsten sind wahrscheinlich am schnellsten.

Eine kleine technische Hilfe ist es, nur das Fenster zu "kopieren" welches den geplanten Inhalt enthält. Dies kann durch Alt-Druck in Windows erfolgen oder in irfanview durch die Auswahl Vodergrund-Fenster in den Einstellungen zu einem Screenshot. In jeweils einem Fenster ist die Wahrscheinlichkeit, dass etwas vergessen wird recht gering, da dieses Fenster ja insgesamt im Fokus des Beitrages liegt und somit automatisch beim Schreiben genauer beobachtet wird.

Fazit

Nehmt euch Zeit beim Schreiben von Blogeinträgen mit Bildern und Screenshots. Veröffentlicht weniger, aber dafür ordentlich und ohne peinliche Fehler.

Installationsanleitung für ST Link und OpenOCD

Das Tutorial, die Anleitung, die Installationsbeschreibung oder wie auch immer die Folgen bezeichnet werden sind wieder um einen Beitrag reicher. Es wird die Installation des ST Links und OpenOCDs beschrieben. Weiterhin werden die notwendigen Anpassungen im ARM GCC Plugin beschrieben.

Das wichtigste ist wahrscheinlich aber das erste kleine Projekt, welches verwendet wird um die ganze Kette zu testen.

Der ganze Beitrag kann [hier] gelesen werden.

Viel Spaß.