Skrypt docgen został napisany w języku Perl i służy do automatycznego generowania dokumentacji i innych zasobów na podstawie plików źródłowych programów technologicznych. Kod źródłowy programu technologicznego jest napisany w języku C i składa się z dwóch plików: prefwyk.c oraz prefdefi.h. Przedrostek o nazwie pref w nazwach plików źródłowych jest oznaczeniem programu technologicznego i może w zależności od przeznaczenia programu technologicznego przyjmować różne nazwy. Aby dokumentacja tworzona na podstawie plików źródłowych była prawidłowo wygenerowana pliki muszą posiadać odpowiednio zaznaczone komentarze. W części dotyczącej dokumentacji programów technologicznych zostanie wyjaśniony szczegółowo sposób tworzenia komentarzy.
Poniższe wywołanie skryptu wyświetli pomoc:
$ ./docgen.pl
Skrypt do generowania dokumentacji z plików źródłowych programów technologicznych
Uzycie:
./docgen.pl prefix [-h] [-t] [-m] [-x] [-n <numer urzadzenia>]
Parametry wywolania:
prefix - nazwa (czteroliterowy poczatek) kompilowanego programu
(parametr obowiazkowy), np /opt/szarp/bin/docgen.pl weze;
mozna ja rowniez podac w formie "z wbudowanym numerem urzadzenia"
np. /opt/szarp/bin/docgen.pl kocz_2
-h - generuj dokumentacje w formacie pliku HTML
-p - generuj dokumentację w formacie pliku PDF (przy użyciu OO.org), załącza opcje -h -s
-o - dodaj przesunięcie do numerów stron w pliku PDF, załącza opcję -p
-s - automatycznie dostosowuj wielkość grafiki na potrzeby pliku PDF
-t - generuj plik z tabelą do wydruku
-x - generuj plik XML z konfiguracją parametrów stałych i paczek czasowych
(dla draw3)
-m - wyslij liste bledow poczta zamiast wyswietlac ja na ekranie
-n <numer urzadzenia> - wygeneruj dokumentacje dla okreslonego numeru
urzadzenia (np. okreslonego numeru kotla)
-C <filename> - nazwa systemowego pliku konfiguracyjnego
(domyslnie /etc/szarp/szarp-plc_config)
-c <filename> - nazwa pliku konfiguracyjnego uzytkownika
(domyslnie /home/jj/.szarp-plc)
-p <filename> - nazwa pliku XML dla draw3 (domyslnie packs.xml)
Brak parametrow - wyswietl pomoc
Wywołanie programu z parametrem:
$ ./docgen.pl weze
spowoduje utworzenie dokumentacji programu technologicznego
oznaczonego przedrostkiem weze na
podstawie plików źródłowych: wezewyk.c
oraz wezedefi.h. Pliki źródłowe muszą
znajdować się w tym samym katalogu, z którego został
wywołany skrypt docgen. Plik wyjściowy
przyjmuje nazwę wezewyk.doc.
Możliwe jest również generowanie dokumentacji z programu, który jest wspólny dla wielu urządzeń (np. dla wielu kotłów) i jest parametryzowany przy użyciu dyrektyw #ifdef oraz #define postaci:
#ifdef XXXX_y
gdzie XXXX jest dowolnym
identyfikatorem, a y jest numerem
urządzenia, innym dla każdego z urządzeń. W takim przypadku
przy wywołaniu skryptu docgen należy
podać parametr -n y, aby wygenerować
dokumentację dla urządzenia numer y. Plik wynikowy przyjmie
w tym wypadku nazwę prefixwyk_y.doc.
| Poprzedni | Spis treści | Następny |
| Przykładowe pliki make.bat | Dokumentacja programów technologicznych |