13.2.15. Automatycznie generowane opisy parametrów na podstawie konfiguracji

Skrypt docgen stara się automatycznie generować opisy parametrów umieszczanych w tabelach parametrów wyświetlanych, parametrów stałych, paczek, wejść i wyjść analogowych oraz wejść logicznych na podstawie konfiguracji sterownika, w którym dany program technologiczny jest zaprogramowany. Odczytywana jest tablica zmiennych przekazywanych do raportu, a następnie, na podstawie kolejności wpisów w raporcie oraz kolejności wpisów w konfiguracji, do zmiennych dopasowywane są opisy znajdujące się w konfiguracji (atrybuty name, draw_name i short_name z IPK) oraz jednostki (atrybut unit). Jeżeli informacje te nie są dostępne (np. dany program nie jest jeszcze zaprogramowany w żadnym sterowniku, więc nie ma do niego konfiguracji), wtedy w odpowiedniej tabeli wpisywany jest komentarz pobrany z kodu programu.

Aby możliwe było wygenerowanie automatyczne opisów na podstawie konfiguracji, w katalogu, w którym znajdują się źródła programu technologicznego, musi znajdować się plik ports o następującej strukturze:

syst
pref1 dev_path1 gen1 opt_directive1
pref2 dev_path2 gen2 opt_directive2
,..
prefn dev_pathn genn opt_directiven 

Gdzie:

• syst - czteroliterowy prefiks systemu ciepłowniczego, w którym zaprogramowane są programy technologiczne z aktualnego katalogu

• prefX - prefiks nazwy programu technologicznego - taki sam, jak ten podawany w argumencie wywołania skryptu docgen

• dev_pathX - ścieżka do urządzenia, które reprezentuje dany sterownik w systemie - taka sama, jak w elemencie device w konfiguracji; jeżeli sterownik nie ma swojej konfiguracji w pliku params.xml - należy jako dev_pathX wpisać null

• genX - wartość 0 lub 1 oznaczająca, czy skrypt docgen ma generować dokumentację dla danego programu technologicznego, czy też pozostawić ją w formie niezmienionej

• opt_directiveX - opcjonalna dyrektywa przekazywana do preprocesora języka C na początku przetwarzania programu przez skrypt docgen.pl, np. KOCIOL_1; skrypt docgen.pl zawsze przekazuje dyrektywę DOCGEN

Istnieje również możliwość wymuszenia pozostawienia dla danego parametru komentarza umieszczonego w kodzie bez względu na zawartość konfiguracji - aby tak się stało pierwszymi znakami danego komentarza muszą być znaki:

<!>