代码拉取完成,页面将自动刷新
同步操作将从 caixw/apidoc 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
// Copyright 2015 by caixw, All rights reserved.
// Use of this source code is governed by a MIT
// license that can be found in the LICENSE file.
package main
import (
"encoding/json"
"io/ioutil"
"log"
"os"
"path/filepath"
"strconv"
"github.com/caixw/apidoc/app"
"github.com/caixw/apidoc/input"
"github.com/caixw/apidoc/output"
"github.com/issue9/version"
)
// 项目的配置内容,分别引用到了 input.Options 和 output.Options。
//
// 所有可能改变输出的表现形式的,应该添加此配置中;
// 而如果只是改变输出内容的,应该直接以标签的形式出现在代码中,
// 比如文档的版本号、标题等,都是直接使用 `@apidoc` 来指定的。
type config struct {
Version string `json:"version"` // 产生此配置文件的程序版本号
Inputs []*input.Options `json:"inputs"`
Output *output.Options `json:"output"`
}
// 带色彩输出的控制台。
type syntaxWriter struct {
}
func (w *syntaxWriter) Write(bs []byte) (int, error) {
app.Error(string(bs))
return len(bs), nil
}
// 加载 path 所指的文件内容到 *config 实例。
func loadConfig(path string) (*config, error) {
data, err := ioutil.ReadFile(path)
if err != nil {
return nil, err
}
cfg := &config{}
if err = json.Unmarshal(data, cfg); err != nil {
return nil, err
}
if !version.SemVerValid(cfg.Version) {
return nil, &app.OptionsError{Field: "version", Message: "格式不正确"}
}
if len(cfg.Inputs) == 0 {
return nil, &app.OptionsError{Field: "inputs", Message: "不能为空"}
}
if cfg.Output == nil {
return nil, &app.OptionsError{Field: "output", Message: "不能为空"}
}
l := log.New(&syntaxWriter{}, "", 0)
for i, opt := range cfg.Inputs {
index := strconv.Itoa(i)
if err := opt.Init(); err != nil {
err.Field = "inputs[" + index + "]." + err.Field
return nil, err
}
opt.SyntaxLog = l
}
if err := cfg.Output.Init(); err != nil {
err.Field = "outputs." + err.Field
return nil, err
}
return cfg, nil
}
// 生成一个默认的配置文件,并写入到 path 中。
func genConfigFile(path string) error {
dir := filepath.Dir(path)
lang, err := input.DetectDirLang(dir)
if err != nil { // 不中断,仅作提示用。
app.Warn(err)
}
cfg := &config{
Version: app.Version,
Inputs: []*input.Options{
&input.Options{
Dir: dir,
Recursive: true,
Lang: lang,
},
},
Output: &output.Options{
Type: "html",
Dir: filepath.Join(dir, "doc"),
},
}
data, err := json.MarshalIndent(cfg, "", " ")
if err != nil {
return err
}
fi, err := os.Create(path)
if err != nil {
return err
}
defer fi.Close()
_, err = fi.Write(data)
return err
}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。