documentation

24Ciepło

1Odpowiedz

Metody adnotacji w Delphi?

Mam kawałek kodu, który wymaga poważnego dokumentowania i chciałem zapytać, czy funkcja podobna do C#/.NET Dokumentacja XML w kodzie jest dostępna dla Embarcadero Delphi. Moim celem jest wyświetlenie

delphi documentation xml-documentation 2013-03-12

---

6Ciepło

1Odpowiedz

notacja streszczenia strony man

Podczas czytania stron man, z mojego doświadczenia wynika, że ​​zawsze była sekcja synopsis. na przykład MV(1) BSD General Commands Manual MV(1) NAME mv -- move files SYNOPSIS mv [-f |

documentation manpage 2013-03-17

---

6Ciepło

2Odpowiedz

dokumentacja Sphinx i AutoDoc-skip-członek

buduję moją sfinks doc dla projektu django następujący sposób: sphinx-apidoc app -o docs/source/app --force Teraz obejmuje wszystkie Południowej migracje, które nie chcą mieć w moja dokumentacja. I

django documentation python-sphinx 2013-05-08

---

7Ciepło

1Odpowiedz

Jaki jest najlepszy sposób użycia: @package, @subpackage i @category

Czytam na phpdoc.org i nie bardzo rozumiem najlepszy czas na użycie @package, @subpackage i @kategorii. Jak na ironię, dokumentacja/przykłady nie są tak pomocne. Czy to tylko ja? Jeśli to pomaga, mam

php wordpress documentation phpdoc commenting 2013-03-31

---

13Ciepło

2Odpowiedz

Jak dokumentować wyjątki metod asynchronicznych?

Sposób próbki z dokumentacją XML: // summary and param tags are here when you're not looking. /// <exception cref="ArgumentNullException> /// <paramref name="text" /> is null. /// </exception> pub

c# .net asynchronous documentation 2013-04-09

---

16Ciepło

3Odpowiedz

Jak dokumentować wyjątek za pomocą Sphinx'a

Nie mogę się domyślić, jak dokumentować wyjątki za pomocą Sphinx. Próbowałem następujące: def some_funct(): """ :raises: ExceptionType: Some multi-line exception description. """

python exception documentation python-sphinx 2013-04-12

---

13Ciepło

2Odpowiedz

Jak określić rozmiar obrazu w HTML Doxygen?

Próbuję ręcznie określić rozmiar obrazu w HTML wygenerowany przez Doxygen. Jednak, jak czytam w documentation, może się to zdarzyć tylko przy użyciu wyjścia LaTeX. Ktoś tutaj zna jakieś obejście? Jako

documentation doxygen image-resizing 2013-04-12

---

5Ciepło

1Odpowiedz

Używanie siebie do tworzenia mapy witryny z toctree w sfinksie wydaje się zepsute?

Aktualizuję często zadawane pytania dotyczące dość dużego projektu i chciałbym dodać indeks pytań u góry strony, aby użytkownicy mogli łatwiej znaleźć to, czego szukają. Dokumentacja Sphinx toctree ar

documentation python-sphinx 2013-04-21

---

7Ciepło

2Odpowiedz

Jak dokumentować parametr "obiekt" metody

Próbuję napisać dokumentację dla metody JavaScript przy użyciu YUIDoc. Wygląda to tak: /** Returns an instance of className @method getInstance @param {string} className the of the cla

javascript documentation yuidoc 2013-03-13

---

14Ciepło

3Odpowiedz

Cała kompilacja strony markdown/pandoc?

Dzięki Sphinx-doc można utworzyć kilka plików ReStructureText z plikiem index.rst, który zawiera makro spisu treści, które automatycznie generuje spis treści z innych dołączonych plików, oraz conf.py,

documentation markdown pandoc pelican 2013-03-14

---