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

[RDY] Doxygen neovim.org theme #824

Merged
merged 4 commits into from Jun 19, 2014

Conversation

Projects
None yet
4 participants
@stefan991
Copy link
Contributor

stefan991 commented Jun 8, 2014

@aktau

This comment has been minimized.

Copy link
Member

aktau commented Jun 8, 2014

The theme looks really nice! Lots of undocumented things to fix.

Something of personal interest: I seem to recall that doxygen was able to generate call graphs for functions. Is that easily enable-able?

Does doxygen have problems with function attributes (as defines/macros)? http://neovim.menkar.uberspace.de/devdoc/neovim_theme/memory_8c.html#aa946fb0a1f9e3d380d37d3fc77b085e4 at the bottom of the page.

@stefan991

This comment has been minimized.

Copy link
Contributor

stefan991 commented Jun 8, 2014

@aktau see https://github.com/neovim/neovim/wiki/Generate-callgraphs-with-Doxygen
It should be easy to enable, but:

Attention: The above configuration will result in doxygen running for about 30 minutes and generating around 2.1GB worth of documentation. A reasonably recent version of the callgraphs should be accessible here if you do not want to generate them yourself.

I don't think I can run this on my sharehoster (http://uberspace.de) without problems.

http://www.stack.nl/~dimitri/doxygen/manual/preprocessing.html might help with function attributes.

@jdavis

This comment has been minimized.

Copy link
Contributor

jdavis commented Jun 8, 2014

That looks great 👍

@jdavis

This comment has been minimized.

Copy link
Contributor

jdavis commented Jun 17, 2014

What's the status on this, @stefan991?

@stefan991

This comment has been minimized.

Copy link
Contributor

stefan991 commented Jun 17, 2014

@jdavis Not sure if this needs to be reviewed as it doesn't touch any code, but after review this can be merged.

@stefan991

This comment has been minimized.

Copy link
Contributor

stefan991 commented Jun 17, 2014

Updated the css to work with doxygen 1.8.7.
Current build is at http://stefan991.github.io/documentation_test/index.html

.gitignore Outdated
@@ -55,4 +55,5 @@
local.mk

# Doxygen output
/documentation/
/documentation/output/

This comment has been minimized.

@justinmk

justinmk Jun 18, 2014

Member

I think this should be /build/doxygen/ , especially since this will be output as a make target.

Doxyfile Outdated

# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location
# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY = documentation
OUTPUT_DIRECTORY = documentation/output

This comment has been minimized.

@justinmk

justinmk Jun 18, 2014

Member

build/doxygen

Doxyfile Outdated
@@ -892,13 +892,13 @@ HTML_FILE_EXTENSION = .html
# have to redo this when upgrading to a newer version of doxygen or when
# changing the value of configuration settings such as GENERATE_TREEVIEW!

HTML_HEADER =
HTML_HEADER = documentation/theme/header.html

This comment has been minimized.

@justinmk

justinmk Jun 18, 2014

Member

All of these newly-added files should probably go in contrib/: https://github.com/neovim/neovim/tree/master/contrib

There was a long discussion about where to support files for third party tools, and that's what we landed on. It would be confusing to have a documentation/ directory which does not actually contain documentation in it. (Most devs won't build doxygen locally, only the build bot... :)

This comment has been minimized.

@justinmk

justinmk Jun 18, 2014

Member

Specific suggestion: the doxygen theme/support files should go in /contrib/doxygen/ (no need for a "theme" subdirectory, after the above changes)

@stefan991

This comment has been minimized.

Copy link
Contributor

stefan991 commented Jun 19, 2014

@justinmk Done.

@stefan991 stefan991 changed the title [RFC] Doxygen neovim.org theme [RDY] Doxygen neovim.org theme Jun 19, 2014

@justinmk justinmk merged commit f02a725 into neovim:master Jun 19, 2014

1 check passed

continuous-integration/travis-ci The Travis CI build passed
Details

justinmk added a commit that referenced this pull request Jun 19, 2014

@justinmk

This comment has been minimized.

Copy link
Member

justinmk commented Jun 19, 2014

Thanks @stefan991

Grimy pushed a commit to Grimy/neovim that referenced this pull request Jan 7, 2015

Merge pull request neovim#824 from mispencer/OmnisharpServerUpdate
Update OmniSharpServer to latest to resolve port issues on windows as non-admin
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment