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

EPL license formatting #168

Closed
skabashnyuk opened this issue Jul 24, 2017 · 2 comments
Closed

EPL license formatting #168

skabashnyuk opened this issue Jul 24, 2017 · 2 comments

Comments

@skabashnyuk
Copy link

skabashnyuk commented Jul 24, 2017

In Eclipse Che I'm trying to adapt Google Java Style Guide eclipse-che/che#5772
As a part of this issue, I want to reformat all our codebase with google-java-format tool.
One of the issues I have is how EPL license looks like after formatting.
Before https://eclipse.org/legal/copyrightandlicensenotice.php

/*******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Codenvy, S.A. - initial API and implementation
 *******************************************************************************/

After

/**
 * ***************************************************************************** Copyright (c)
 * 2012-2017 Codenvy, S.A. All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 *
 * <p>Contributors: Codenvy, S.A. - initial API and implementation
 * *****************************************************************************

Can you suggest me a better way to put result closer to the original?
I have two ideas for now.

  1. Just skip javadoc formatting. Need to wait for Add flag for skipping javadoc formatting #149
  2. Put <br> at the end of each line.
/**
* *****************************************************************************<br>
* Copyright (c) 2012-2017 Codenvy, S.A.<br>
* All rights reserved. This program and the accompanying materials<br>
* are made available under the terms of the Eclipse Public License v1.0<br>
* which accompanies this distribution, and is available at<br>
* http://www.eclipse.org/legal/epl-v10.html<br>
*
* <p>Contributors:<br>
* Codenvy, S.A. - initial API and implementation<br>
* *****************************************************************************
*/

3. Try to move license from javadoc to comment.
@cushon
Copy link
Collaborator

cushon commented Jul 26, 2017

Is changing the license header style an option? /******************************************************************************* is technically the beginning of a javadoc comment. It might be better to use:

/*
 * Copyright (c) 2012-2017 Codenvy, S.A.
...

or perhaps:

/* ******************************************************************************
 * Copyright (c) 2012-2017 Codenvy, S.A.
...

@skabashnyuk
Copy link
Author

Yes. And Eclipse IP(intellectual property) team just confirm that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants
@cushon @skabashnyuk and others