SZARP PLC HOWTO | ||
---|---|---|
Poprzedni | Rozdział 13. Automatycznie generowana dokumentacja do programów technologicznych przy użyciu skryptu docgen | Następny |
Skrypt docgen automatycznie sprawdza poprawność ortograficzną sekcji komentarza ogólnego (opis: Sekcja 13.2.10). Sprawdzanie wykonywane jest przy użyciu programu aspell w trybie odpowiednim dla dokumentów w formacie HTML. Ignorowane są słowa o długości mniejszej bądź równej cztery znaki, co pozwala uniknąć niepoprawnego wykrywania nazw skróconych (z IPK) jako błędnych ortograficznie.
Domyślnym sposobem raportowania błędów jest wyświetlenie ich na standardowym wyjściu błędów. Jednak, w przypadku pracy wsadowej, przydatna jest możliwość wysłania maila osobie, która jako ostatnia zmodyfikowała dany plik źródłowy. Informacje o tym kto ostatni zmodyfikował dany plik brane są z logów SVN, a następnie lista błędnych słów wysyłana jest na adres <author>@praterm.com.pl, gdzie człon <author> jest informacją wydobytą z SVN-a. Zachowanie takie można włączyć podając przełącznik -m w linii komend.
Poprzedni | Spis treści | Następny |
Automatycznie generowane opisy parametrów na podstawie konfiguracji | Początek rozdziału | Dobre zwyczaje obowiązujące przy pisaniu dokumentacji |