Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use EDoc format internally #30

Open
yurrriq opened this issue Nov 18, 2016 · 4 comments
Open

Use EDoc format internally #30

yurrriq opened this issue Nov 18, 2016 · 4 comments

Comments

@yurrriq
Copy link
Member

yurrriq commented Nov 18, 2016

Right now we use a custom internal state based heavily on lfe_doc_v1 records. It might be worthwhile to adopt the EDoc record format.

Related:

@yurrriq yurrriq changed the title Consider internal EDoc representation Use EDoc format internally Nov 25, 2016
@yurrriq
Copy link
Member Author

yurrriq commented Nov 26, 2016

I'm making some progress on this locally. Too messy to commit yet, but it's looking promising. I think I'll split the lodox project into two apps:

  • lodox (the rebar3 plugin)
  • ldoc (the lfe_docs_v1 parser and EDoc generator)

@yurrriq
Copy link
Member Author

yurrriq commented Nov 26, 2016

@oubiwann, @rvirding:

Do you think I should make ldoc a separate repo, or just keep it here under apps/? Possible motivation for the former could be if a user wants to manipulate EDoc records generated from LFE source themselves, outside of Lodox.

I'm leaning toward apps/, for now anyway.

If you vote separate repo, could you create lfex/ldoc and give me admin privileges?

@yurrriq
Copy link
Member Author

yurrriq commented Nov 26, 2016

It might also be good to split out the forthcoming markdown, JSON and text writers into their own repos. Those belong in the lfe-rebar3 org, I think. I figure lodox-{{format}} is a good naming scheme, if we decide to do that.

@yurrriq
Copy link
Member Author

yurrriq commented Nov 26, 2016

Hmm, on second thought, we probably won't need a rebar3 plugin anymore, since I'm writing an EDoc doclet module in ldoc...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
EDoc rewrite
In Progress
Development

No branches or pull requests

1 participant