Описание тега scaladoc
Scaladoc - это система генерации документации, которая считывает специально отформатированные комментарии в исходном коде Scala и генерирует скомпилированную документацию. Обычно он используется для создания документации API в виде веб-страниц HTML.
1
ответ
Как отключить генерацию ScalaDoc в задании dist в Play 2.2.x (используя project/build.scala)?
Добавление следующих настроек в build.sbt Файл приложения Play 2.2.x не отключает генерацию Scaladoc. Как это можно отключить? play.Project(appName, appVersion, appDependencies) .settings(scalaVersion := "2.10.3") .settings(jsSettings : _*) .setting…
30 янв '14 в 16:18
1
ответ
Как убежать /* в скаладоке?
У меня есть комментарий, который содержит пример конфигурации сервлета Java. Это выглядит как: /** Blah blah blah... * * {{{ * <servlet-mapping> * <servlet-name>MyAppServlet</servlet-name> * <url-pattern>/app/*</url-patter…
30 май '14 в 17:07
1
ответ
Scaladoc скрывает наследуемые элементы по умолчанию
Я использую sbt doc создать документацию для проекта Scala. При использовании настроек по умолчанию в документации автоматически отображаются унаследованные элементы, как показано на следующем снимке экрана. В идеале я хотел бы создать документацию,…
19 фев '15 в 07:09
2
ответа
Как создать Scaladoc для Java-проекта Maven+Scala 2.8+ с помощью Scaladoc 2
Вопрос говорит обо всем. Я не смог найти в Интернете пример использования Scaladoc 2, особенно в проекте Maven. Я использую Maven, Scala 2.8 и некоторые классы Java, а также плагин Maven Scala для создания проекта. Но, как мне кажется, я не могу исп…
11 авг '10 в 13:12
3
ответа
Где scaladoc ищет файл rootdoc.txt для создания корневого документа
Это дубликат Generate scaladoc для корневого пакета, однако в ответе не указано, где sbt doc ищет rootdoc.txt, я добавил scalacOptions in doc ++= Seq("-doc-root-content", "rootdoc.txt") к моему build.sbt, но sbt doc похоже не сканирует его. Я пыталс…
20 май '13 в 07:53
0
ответов
Сбой генерации Scaladoc при обращении к методам, сгенерированным макросами аннотаций
У меня есть два класса, позвоните им Foo а также Fizz, Foo использует макрос аннотации под названием expand создавать псевдонимы некоторых из его методов (фактическая реализация делает немного больше, чем создание псевдонимов, но простая версия все …
08 мар '17 в 23:45
1
ответ
Обертывание Скаладока на правом поле в IntelliJ
Можно ли как-нибудь заставить IntelliJ обернуть скаладок на полях? В основном, я хочу это: /** * This is a method description that is long enough to exceed right margin. * <p/> * Another paragraph of the description placed after blank line. * …
06 май '11 в 14:28
0
ответов
Scaladoc, SBT и case-классы, а также версия scala 2.11.x
У меня есть проблема при создании scaladoc для scala 2.11.7 в проекте Intellij IDEA SBT с классами case. Например, с этим кодом: package main /** * * @param a */ case class SomeClass(a: Int) { } когда я пытаюсь сгенерировать скаляр, возникает исключ…
23 окт '15 в 13:55
0
ответов
scaladoc - как включить определенные классы?
Я создаю scaladoc с использованием net.alchim31.maven плагин в mavenи все классы создаются в папке сайта. Как можно включить только определенные классы? Я попробовал следующее в pom.xml но это не сработало для меня: <plugin> <groupId>net…
01 авг '18 в 14:42
1
ответ
Как настроить документы Scala API для IntelliJ
Scala устанавливается с помощью homebrewи когда я создаю новый проект Scala, я использую путь /usr/local/opt/scala/idea с правильными символическими ссылками IntelliJ правильно определяет компилятор и библиотеки, автозаполнение, компиляция и запуск …
28 окт '13 в 08:35
1
ответ
Как включить комментарии для пакета с scaladoc?
Таким образом, для scaladoc, вы можете указать комментарии для определенного компонента вашего кода следующим образом: package connector import java.io.RandomAccessFile; /** Fs class guides file opening * */ object fs { def printFile(path:String):Un…
05 май '17 в 17:05
1
ответ
Как создать Scaladocs из проекта Eclipse
Я хочу начать создавать скалярные документы из моего проекта Eclipse. Я не использую SBT, но готов импортировать мой проект eclipse в sbt, если это необходимо. Как мне создать Scaladocs из проекта Scala затмения?
26 мар '13 в 13:03
1
ответ
Скалярное задание Ant для нескольких исходных каталогов?
Я хочу скомпилировать scaladoc и javadoc в проекте, в котором есть и scala, и java. Проект имеет более одного исходного каталога (каждый из которых может иметь scala или javadoc). Я старался: <scaladoc destdir="doc"> <classpath refid="compi…
26 июл '10 в 14:56
3
ответа
Как искать методы в Scaladoc, глобально?
Есть ли возможность, что я могу искать метод в классе, признаке или объекте через scala doc, глобально? Пример: у меня есть имя метода, и я не знаю, к какому классу он принадлежит, поэтому я могу напечатать его в каком-то поиске по скаладоку, и он п…
14 июл '11 в 21:47
1
ответ
Настройте scaladoc для включения методов расширения
Могу ли я настроить scaladoc для включения методов неявных преобразований, указав неявное преобразование? Например дано trait Foo object Operations { implicit class FooOps(val f: Foo) extends AnyVal { def bar = 33 } } Могу ли я сделать скалярный мет…
28 янв '14 в 12:59
1
ответ
Замените полные типы псевдонимами типов в Scaladoc
У меня есть черта с 4 параметрами типа: Decoder[E, D, F, T] (где E описывает закодированный тип, D декодированный тип, F тип отказа и T является фантомным типом, используемым для маркировки экземпляров декодера). Каждый проект, который определяет по…
20 окт '16 в 21:12
0
ответов
Библиографические цитаты в ScalaDoc
Несколько инструментов документирования поддерживают создание библиографий и маркеров цитирования. Например, построитель файлов справки Sandcastle позволяет определить <reference>и ссылаясь на них <cite> MAML теги. R Markdown поддерживае…
25 дек '16 в 13:22
3
ответа
Почему скаляр считает, что HashMap.toArray возвращает Array[A] вместо Array[(A,B)]?
Я смотрел на определение toArray для хешмапов: http://www.scala-lang.org/api/current/index.html Она имеет toArray: Array[A] def toArray[B >: (A, B)](implicit arg0: ClassTag[B]): Array[B] Я не совсем понимаю - первая часть говорит, что вы получает…
24 июн '13 в 14:30
0
ответов
Настройка задачи ScalaDoc в Gradle для генерации агрегированной документации
У меня есть многомодульный проект Scala в Gradle. С ним все прекрасно работает, кроме ScalaDoc. Я хотел бы создать один 'uber-scaladoc' со всеми библиотеками, сшитыми. Я все еще очень плохо знаком с Groovy / Gradle, так что это, вероятно, проблема "…
07 окт '14 в 13:41
1
ответ
Как просмотреть Scala Doc в затмении
Я использую Eclipse для написания кода Scala. Я установил плагин Scala в Eclipse. В среде Java в Eclipse есть объяснения, доступные для каждого встроенного метода, но для Scala Eclipse не показывает Scala doc. Что я могу сделать, чтобы увидеть Scala…
21 окт '14 в 09:18