Документация по SourceMod на форуме

[Kruzya]

Есть идея впилить документацию по SourcePawn API на форуме, вынеся в отдельную вкладочку. При этом:

1. Реализовать комментарии к функциям/энумам/инклудам/методмапам.
2. В отличие от официальной доки, строить дерево наследования для методмапов и показывать все методы (у всех хендлов, например, есть метод Close(), который работает как CloseHandle()).
3. Интегрировать с форумом. Добавить в редакторе кнопку, которая позволит сослаться на метод в документации.
4. Инклуды для плагинов от сообщества (?), по типу VIP Core от Рико или Шоп от Фроза (но будет конкретно форк).
5. Интеграция с системой закладок. Речь про эту:
   

Что-то уже сделано:


Выкладываю эту тему в веб-разработке на обсудить пока.

 

[Young <]

Я думаю мб еще создать базу инклюдов, чтобы не бегать по интернету, когда нужен определенный инк.

 

[Grey83]

Моё мнение ты знаешь.

 

[Саша Шеин]

Предлагаю кроме всего перечисленного, сделать документацию по правильному документированию inc , так чтобы не было проблем с обработкой.

А также сделать несколько веток, для sm < 1.7 и для sm > 1.9 , хотя не знаю, много ли здесь людей нуждаются в старой версии синтаксиса.
Но многие используемые инклюды приходится переделывать со старого синтаксиса.

А также, если пользователь размещает в ресурсах ядро плагина или плагин в котором есть нативы / форварды добавить возможность отдельно загрузить inc или же описание функций. Но лучше inc чтобы в последствии была возможность скачать нужный inc без всего остального. Например удобно будет иметь какой-то раздел в описании ресурса, где нажал кнопочку и тебя перекинула на нужный inc с описанием функций и кнопкой скачать. (Если плагин использует сторонние библиотеки, то часто приходится искать их самому)

 

[Kruzya]

А также, если пользователь размещает в ресурсах ядро плагина или плагин в котором есть нативы / форварды добавить возможность отдельно загрузить inc или же описание функций.

А тут сложно, ибо каждый ведёт архивы так, как ему удобно. Плюс не все загружают архивы на форум, кто-то ссылкой указывает.

 

[NaN]

А тут сложно, ибо каждый ведёт архивы так, как ему удобно. Плюс не все загружают архивы на форум, кто-то ссылкой указывает.

можно вручную сделать загрузку .inc

 

[Саша Шеин]

А тут сложно, ибо каждый ведёт архивы так, как ему удобно. Плюс не все загружают архивы на форум, кто-то ссылкой указывает.

@Kruzya, про архив согласен, но я имел ввиду, добавить новое поле для загрузки .inc , как и написал @NaN

можно вручную сделать загрузку .inc

 

[NaN]

Главное всем подряд такие права не давать и все будет нормально.

 

[Саша Шеин]

Кстати, как вариант можно сделать генератор inc, т.е. интерфейс для шаблонного заполнения описания, который будет помогать составить inc корректно

Сообщения автоматически склеены: 17 Июн 2020

Главное всем подряд такие права не давать и все будет нормально.

Думаю можно сделать с модерированием, как у ресурсов, т.е. пока ресурс не одобрен - inc не загрузится и не обработается. И последующие обновления inc тоже модерировать

 

[dvernoff]

Прикольно, несомненно жду релиза.

 

[Kruzya]

можно вручную сделать загрузку .inc

Тогда придётся и архивы, всё же, частично саппортить в этом поле, ибо есть плагины по типу Шопа от Фроза, где инклуда не одна, а несколько, да ещё и в папке часть.

А мне кажется всё же более правильным решением не добавлять сразу инклуду в доку. Только спустя какое-то время, и по запросу к администрации. Прогон парсера сейчас - операция не быстрая. Я использую за основу официальный парсер инклуд SourcePawn, который написан на Си, и чтобы не ломать политику безопасности о "запрете запуска исполняемых файлов через PHP", поднят небольшой HTTP-сервис, написанный на ноде, который берёт на вход инклуду, а в ответ отдаёт модифицированный результат прогона докпарсера над ним (добавляется распарсенная дока).


Репозиторий инклуд-файлов - да, было бы неплохо. Его даже придётся делать, поскольку в админке сейчас при добавлении инклуд-файла нужно указать адрес, откуда брать файл.

 

[Kruzya]

Может в конце недели раскатаю тестовую версию здесь, и дам доступ ограниченному кругу лиц для комментариев. К тому моменту скорее всего закончу реализацию вывода всех данных, которые только докген сейчас мне отдаёт.

 

[Kruzya]

Запилил вывод методов и свойств у методмап. Вместо классического отображения "как в официальной доке", запилил вкладочками.

 

[Kruzya]

Установлено, закладка должна была появиться в верхнем навбаре у тех, у кого имеется возможность публиковать ресурсы без премодерации (почти, но это отдельная история) и у модераторов.
Текущие известные недостатки, которые будут исправляться в течение ближайшей недели (или больше):

• Английский язык в дополнении.
• Отсутствие ссылок на типы данных в таблице аргументов у функций.
• Нормальный шаблон для тайпсетов.

Так же планируется:

• Сделать бб-код с виджетом, который позволит прямо в сообщении сослаться на интересуемый метод/форвард.
• Закладки для свойств.

Если что-то будет обнаружено - лучше писать не в данной теме, а в "баг-трекере": XF-SPApiDoc-BugTracker
Регистрация доступна.

 

[West14]

Наконец-то релизнулось.
Hehe boi.

 

[dvernoff]

Ну-да ну-да, пошёл я нафиг ;(

 

[Virus]

Ну-да ну-да, пошёл я нафиг ;(

Эта документация скоро и у всех наверное появится после тестов, что ты переживаешь то.

 

[Webman]

Можно еще полнотекстовый поиск реализовать (например, Elasticsearch) в реалтайме.
Тот же поиск на alliedmodders работает медленно и неудобно.

 

[NaN]

Можно еще полнотекстовый поиск реализовать (например, Elasticsearch) в реалтайме.
Тот же поиск на alliedmodders работает медленно и неудобно.

Поиск есть. Причём с использованием эластика.

 

[Kruzya]

Можно еще полнотекстовый поиск реализовать (например, Elasticsearch) в реалтайме.

Там под капотом используется движковый поиск, который сейчас настроен и работает именно на Эластике.
Ну и да, он умеет искать по описанию функции: