标签: documentation

我正在寻找一个参考资料,它总结了HTML 5中引入的所有可用Javascript API,适用于已实现任何新功能的每个浏览器.这样的事情存在吗？如果没有别的,那么至少是VIDEO标签

虽然与这个关于在数学和学术界之外使用的LaTeX的问题有关,但我特别想知道是否有人使用或熟悉使用LaTeX生成与软件相关的任何类型文档的任何人.如果是这样,你能否说你是否喜欢LaTeX以及你使用它的目的？谢谢.

我正在使用Sphinx来记录将部署在不同服务器中的Web服务.该文档中包含用户单击的URL示例,它们应该可以正常工作.我的问题是主机,端口和部署根目录会有所不同,必须为每个部署重新生成文档.

我尝试定义这样的替换:

|base_url|/path
.. |base_url| replace:: http://localhost:8080

但生成的HTML不是我想要的(在生成的链接中不包括"/ path"):

<a href="http://localhost:8080">http://localhost:8080</a>/path

有人知道如何解决这个问题吗？

我正在寻找一本详尽的大学级书籍或学习指南,以便能够编写Mac OS X设备驱动程序.我对这个操作系统完全无知,但我已经熟练使用Linux了.

书籍"Linux设备驱动程序"是否有任何Mac OS X版本？

最佳指南也应该引入OS内部,明确内核空间和用户空间差异等.

提前致谢

我是python和python win32扩展的新手,可以在http://python.net/crew/skippy/win32/上找到,但是我无法在线或在安装目录中找到任何关于win32扩展提供的文档.这些信息在哪里？

我找不到可下载版本的Clojure参考手册(最好是PDF).有没有人知道我可以下载的地方？

我在我的项目中使用PHP和JavaScript,我完全使用netbeans 7.0.1编写代码.我非常喜欢netbeans如何包含和使用JavaDoc注释样式,包括PHP和JS代码.

现在,我想从PHP和JS代码生成代码文档.我知道有几种方法可以做到这一点,但我的主要目标是在一个文档中包含两个部分的文档.

进一步解释:例如,我可以使用Doxygen并处理PHP文件和JsDoc来处理JS文件.结果是,我现在在两个不同的文件夹中有两个不同的文档 - 一个我不喜欢的结果.正如我所提到的,我想在一个文档中.

所以,首先我使用doxygen helper js2doxy.pl(http://jsunit.berlios.de/internal.html),但这不够灵活.它适用于"普通"定义的函数,但不适用于匿名的js函数.

经过一些尝试后,我想为什么不改变文件的FILE_PATTERNS选项来处理.js文件,因为注释的JavaDoc样式几乎与PHP使用的相同.好吧,结果看起来很有希望,但文档中缺少一些功能.

以下是示例:

/**
 * Definitions for the languages.
 * @memberof Language
 */
Language.Definitions = (function()
{
...
}

这很好用,我可以看到文档.但:

**
 * Definitions for the languages
 * @memberof Language
 */
Language.Definitions = (function()
{
    var Translations = {};

    /**
     * Replaces strings.
     * @memberof Language
     * @param string translation Translation string 
     * @param array parameters (optional) List of parameters
     * 
     * @return string replaced string
     */
    function replaceStrings(translation, …

让我们说我有一个函数(显然是一个简单的例子):

public function dot(){
    return implode('.', func_get_args());
}

现在我知道我可以修改它

public function dot(array $items){
    return implode('.', $array);
}

但有些功能不是一种选择.那么,您如何使用docBlock记录该函数的第一个版本,以便IDE可以解释它可以接收无限制的参数？

我见过一些使用的方法:

/**
 * Joins one or more strings together with a . (dot)
 * @param string $string1
 * @param string $string2
 * @param string $_ [optional]
 * @return string
 */
public function dot($string1, $string2, $_ = null) {
    return implode('.', func_get_args());
}

在IDE中看起来像

但这对我来说就像是一个黑客攻击,有没有办法只用docBlock来做到这一点？

我已经使用GitHub页面为我的项目生成一个漂亮的网站(这个).现在我想保持我的项目文档是最新的,并且在一个README.md文件中包含所有内容可能无法扩展到我们添加的许多功能.

所以,我认为保存文档的最佳位置是GitHub wiki,但我想将wiki集成到gh-pages生成的站点,保持漂亮的布局.

我如何使用GitHub wiki并生成具有可自定义布局的HTML网站？

我试图从 Swagger 文档向本地 API 发出请求，但当我发出请求时它总是给出此错误