Return to module.dox CVS log

Up to [parser3project] / parser3 / src / doc

Annotation of parser3/src/doc/module.dox, revision 1.3

1.2       paf         1: /**    @page module  Синтаксис входных файлов
1.1       paf         2: 
1.2       paf         3: Все входные файлы называются модулями, и имеют синтаксис:
1.1       paf         4: @verbatim
                      5: @CLASS
1.2       paf         6: Имя_класса
1.1       paf         7: 
                      8: @BASE
1.2       paf         9: Имя_базового_класса
1.1       paf        10: 
                     11: @USE
1.2       paf        12: Список
                     13: Модулей
                     14: Которые
                     15: Нужны
                     16: В
                     17: Этом
                     18: Модуле
1.1       paf        19: 
1.2       paf        20: @метод1[параметр1;параметр2][локальная_переменная1;локальная_переменная2] комментарий
                     21: тело метода
1.1       paf        22: @endverbatim
                     23: 
1.2       paf        24: при этом CLASS, BASE, USE части необязательны.
                     25: Запрашиваемый пользователем документ, компилируется в класс с предопределённым названием "MAIN", и его имя сменить нельзя.
                     26: Файл с именем auto.p, найденный в том же каталоге, где и запрошенный пользователем документ, 
                     27: компилируется в безымянный[на деле, тоже в имя "MAIN"] класс, и становится родителем класса, в который скомпилировался
                     28: запрошенный пользователем документ.
                     29: Файл auto.p из ../ каталога, компилируется в родителя следующего уровня, и так далее.
                     30: Дополнительно:
1.3     ! paf        31: - Apache: файл parser3.conf из файла, 
        !            32:   задаваемого директивой parser_site_config[допустима в .htaccess], 
        !            33:   а затем, parser_root_config[допустима только в конфиге сервера]
        !            34: - CGI: файл parser3.conf из каталога, рядом с бинарником скрипта[обычно cgi-bin],
        !            35:   или, если задана, из файла, чьё имя указано в переменной окружения HTTP_PARSER_SITE_CONFIG,
        !            36:   а затем из windows directory [c:\winnt] под windows и из указанного при configure под UNIX, см. INSTALL.
        !            37:   или из переменной окружения HTTP_PARSER_ROOT_CONFIG
        !            38: - ISAPI: parser3.conf рядом с бинарником ISAPI фильра, затем из из windows directory [c:\winnt]
1.1       paf        39: 
                     40: */